Skip to main content

Update an Api Resource for the given organisation and Authorisation Server

PUT 
/organisations/:OrganisationId/authorisationservers/:AuthorisationServerId/apiresources/:ApiResourceId

updates a specific api resource

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

    Possible values: non-empty and <= 40 characters, Value must match regular expression ^[^<>]*$

    The organisation ID

    AuthorisationServerId AuthorisationServerIdrequired

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The authorisation server Id

    ApiResourceId ApiResourceIdrequired

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The api version Id

Header Parameters

    x-fapi-auth-date string

    Possible values: Value must match regular expression ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$

    The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC

    x-fapi-customer-ip-address string

    The PSU's IP address if the PSU is currently logged in with the TPP.

    x-fapi-interaction-id string

    An RFC4122 UID used as a correlation id.

    x-customer-user-agent string

    Indicates the user-agent that the PSU is using.

Body

Api Resource update request

    ApiFamilyType ApiFamilyType (string)required

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[^<>]*$

    The type of API this record describes

    ApiVersion stringrequired

    Possible values: Value must match regular expression ^([0-9]+\.[0-9]+\.[0-9]+)$|^([0-9]+)$

    The version number of the API

    ApiCertificationUri uri

    Possible values: <= 500 characters, Value must match regular expression ^(https://).*

    Link to the certifation package. Example https://github.com/Open[Domain]/conformance/blob/main/submissions/functional/business/1.0.3/api-business-customer.zip

    ApiEndpoint ApiEndpoint (string)

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

    CertificationStatus CertificationStatusEnum (string)required

    Possible values: [Awaiting Certification, Certified, Deprecated, Rejected, Warning, Self-Certified]

    Default value: Awaiting Certification

    The different types of certification status

    CertificationStartDate stringnullable

    Possible values: <= 10 characters, Value must match regular expression ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$

    Status StatusEnum (string)required

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Responses​

Authorisation server Api Resource response

Response Headers

  • x-fapi-interaction-id

    string

Schema

    ApiDiscoveryEndpoints

    object[]

  • Array [

    • ApiDiscoveryId ApiEndpointId (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The unique ID of an Api discovery endpoint resource

    ApiEndpoint ApiEndpoint (string)

    Possible values: <= 255 characters, Value must match regular expression ^(http://|https://).*

    A compliant URI

  • ]

    • ApiMetadata object
    ApiResourceId ApiResourceId (string)

    Possible values: <= 40 characters, Value must match regular expression ^[^<>]*$

    The unique ID of an Api version resource

    ApiVersion string

    Possible values: Value must match regular expression ^([0-9]+\.[0-9]+\.[0-9]+)$|^([0-9]+)$

    The version number of the API

    FamilyComplete boolean

    Denotes whether or not the api resource has had all related api endpoints published

    ApiCertificationUri uri

    Possible values: <= 500 characters, Value must match regular expression ^(https://).*

    Link to the certifation package. Example https://github.com/Open[Domain]/conformance/blob/main/submissions/functional/business/1.0.3/api-business-customer.zip

    CertificationStatus CertificationStatusEnum (string)

    Possible values: [Awaiting Certification, Certified, Deprecated, Rejected, Warning, Self-Certified]

    Default value: Awaiting Certification

    The different types of certification status

    CertificationStartDate CertificationStartDate (string)

    Possible values: Value must match regular expression ^[0-3][0-9]/[0-1][0-9]/2([0-9]{3})$

    JSONDatetime of certification start date

    CertificationExpirationDate CertificationExpirationDate (string)

    Possible values: Value must match regular expression ^[^<>]*$

    JSONDatetime of certification expiration date

    ApiFamilyType ApiFamilyType (string)

    Possible values: non-empty and <= 128 characters, Value must match regular expression ^[^<>]*$

    The type of API this record describes

    Status StatusEnum (string)

    Possible values: [Active, Inactive]

    Default value: Active

    Current status of this resource

Loading...