service-descriptions

refresh selected service description

Changed on
<h3>Administrator refreshes service description.</h3> <p> This endpoint can also return metadata in the error response if refreshing the service description fails due to invalid URLs, already existing service description or already existing services. If refreshing the service description fails due to an invalid service URL, the error response will have the error code <code>invalid_service_url</code> and the metadata will contain a list of invalid URLs. If refreshing the service description fails due to an already existing service description, the error response will have the error code <code>url_already_exists</code> and the metadata will contain the existing URL. If refreshing the service description fails due to already existing services, the metadata array will have a more complex format. See the description of the '409' response in this endpoint. </p> <p> This endpoint can return a warnings response which can be ignored by setting <code>IgnoreWarnings.ignore_warnings</code> = true. If <code>IgnoreWarnings.ignore_warnings</code> = false, a warnings response will be returned if any one of the following conditions is true <ul> <li>WSDL or OpenAPI3 validation fails and validation warnings are returned (warning code will be either <code>wsdl_validation_warnings</code> or <code>openapi_validation_warnings</code>)</li> <li>existing services will be removed (warning code <code>deleting_services</code> and the warning metadata contains a list of service codes that will be removed)</li> <li>new services will be added (warning code <code>adding_services</code> and the warning metadata contains a list of service codes that will be added)</li> </ul> </p>
put/service-descriptions/{id}/refresh

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

Path parameters

idstring text required

id of the service description

Request body

ignore_warningsboolean

if true, any ignorable warnings are ignored. if false (or missing), any warnings cause request to fail

Response

service description refreshed

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

    • ○

      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

    • ▲

      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