Sign in
service-descriptions

get service description with provided id

Changed on
<h3>Administrator views a service description with a certain id.</h3>
get/service-descriptions/{id}

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/service-descriptions/{id}
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the service description

Response

wanted service description

idstring required

unique identifier

urlstring url required

service url

type'WSDL' | 'REST' | 'OPENAPI3' text required

service type

disabledboolean required

service disabled

disabled_noticestring text required

disabled notice

refreshed_atstring date-time required

time for service refresh

client_idstring text required

<instance_id>:<member_class>:<member_code>:<subsystem>(optional)

Example response

{
  "url": "http://dev.xroad.rocks/services.wsdl",
  "type": "WSDL",
  "disabled": true,
  "disabled_notice": "default_disabled_service_notice",
  "refreshed_at": "2018-12-15T00:00:00.001Z",
  "services": [
    {
      "id": "CS:ORG:Client:myService.v1",
      "client_id": "FI:GOV:123:ABC",
      "full_service_code": "myService.v1",
      "service_code": "myService",
      "timeout": 60,
      "title": "client deletion",
      "ssl_auth": true,
      "subjects_count": 5,
      "url": "https://domain.com/service",
      "endpoints": [
        {
          "service_code": "example_service_code",
          "client_id": "FI:GOV:123:ABC",
          "method": "GET",
          "path": "/foo",
          "generated": true
        }
      ]
    }
  ],
  "client_id": "FI:GOV:123:ABC"
}

Changes

  • 26d051d8c39eRevision changes
    • ○

      added the optional property //// to the response with the status

    • ○

      added the required property // to the response with the status

    • ○

      added the required property // to the response with the status

  • 86ab791a2584Revision changes
    • ▲

      removed the required property // from the response with the status

    • ▲

      removed the required property // from the response with the status

    • ●

      removed the optional property //// from the response with the status