apfId, service-apis and serviceApiId
get:
Description: Retrieve a published service API.
Parameters:
- name: serviceApiId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/serviceApiId'
- name: apfId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/apfId'
Responses:
'200' Definition of all service API published by the API publishing function.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ServiceAPIDescription'
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'406': Reference 'TS29122_CommonData.yaml#/components/responses/406'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
put:
Description: Update a published service API.
Parameters:
- name: serviceApiId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/serviceApiId'
- name: apfId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/apfId'
Request Body:
Required/Optional: true
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ServiceAPIDescription'
Responses:
'200' Definition of service API updated successfully.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/ServiceAPIDescription'
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'411': Reference 'TS29122_CommonData.yaml#/components/responses/411'
'413': Reference 'TS29122_CommonData.yaml#/components/responses/413'
'415': Reference 'TS29122_CommonData.yaml#/components/responses/415'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
delete:
Description: Unpublish a published service API.
Parameters:
- name: serviceApiId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/serviceApiId'
- name: apfId
In: path
Required/Optional: true
Schema:
Reference: '#/components/schemas/apfId'
Responses:
'204' The individual published service API matching the serviceAPiId is deleted.
'400': Reference 'TS29122_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29122_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29122_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29122_CommonData.yaml#/components/responses/404'
'429': Reference 'TS29122_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29122_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29122_CommonData.yaml#/components/responses/503'
default: Reference 'TS29122_CommonData.yaml#/components/responses/default'
# Components