Sign in
service-descriptions

get services for the selected service description

Changed on
<h3>Administrator views the services for the selected service description.</h3>
get/service-descriptions/{id}/services

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}/services
  • Auth: API key in header Authorization

Path parameters

idstring text required

id of the service description

Response

list of services

idstring text required

encoded service id, including client id

service_description_idstring required

unique identifier

client_idstring text required

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

full_service_codestring text

encoded service code and version

service_codestring text required

encoded service code

timeoutinteger required

service time out value

titlestring text

service title

ssl_authboolean

service ssl auth

subjects_countinteger

count of acl subjects

urlstring url required

service url

Example response

[
  {
    "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
      }
    ]
  }
]

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