Skip to main content

Create and execute a Conformance Suite test plan for the given organisation

POST 
/organisations/:OrganisationId/conformancetest

creates and runs a conformance suite test based on the configuration document

Request​

Path Parameters

    OrganisationId OrganisationIdrequired

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

    The organisation 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

required

Create and run a Conformance Suite test

    ResourceUrl stringrequired

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

    The url of the API to be tested (for example, https://matls-api.mockbank.poc.raidiam.io/open-banking/products-services/v1/personal-accounts)

    ApiFamilyType stringrequired

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

    The family type of the resource url to be tested (for example channels_branches)

    Version stringrequired

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

    The version of the api family to be tested (for example 1.0.0)

Responses​

Result of the conformance suite test run

Response Headers

  • x-fapi-interaction-id

    string

Schema

    result boolean

    Boolean with the result of the execution of the Conformance Suite Test

    testPlanUrl string

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

    URL of the published test plan result

    errorCount integer

    Number of errors found during the execution of the Conformance Suite Test

    errors string[]

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

    List of distinct errors found during the execution of the Conformance Suite Test

Loading...