/bdtpolicies/{bdtPolicyId}
get:
Summary: Read an Individual BDT policy
Operation ID: GetBDTPolicy
Tags:
- Individual BDT policy (Document)
Parameters:
- name: bdtPolicyId
Description: String identifying the individual BDT policy resource in the PCF.
In: path
Required/Optional: true
Schema:
Type: string
Responses:
'200' Background data transfer policies offered to and selected by an ASP.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/BdtPolicy'
# Error scenarios GET
'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'
'406': Reference 'TS29571_CommonData.yaml#/components/responses/406'
'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'
default: Reference 'TS29571_CommonData.yaml#/components/responses/default'
# End error scenarios GET
patch:
Summary: Update an Individual BDT policy
Operation ID: UpdateBDTPolicy
Tags:
- Individual BDT policy (Document)
Parameters:
- name: bdtPolicyId
Description: String identifying the individual BDT policy resource in the PCF.
In: path
Required/Optional: true
Schema:
Type: string
Request Body:
Description: Contains modification instruction to be performed on the BdtPolicy data structure to select a transfer policy.
Required/Optional: true
Content:
application/merge-patch+json:
Schema:
Reference: '#/components/schemas/BdtPolicyDataPatch'
Responses:
'200' The Individual BDT Policy resource is modified and a representation of that resource is returned.
Content:
Application/JSON:
Schema:
Reference: '#/components/schemas/BdtPolicy'
'204' The Individual BDT Policy resource is modified.
# Error scenarios PATCH
'400': Reference 'TS29571_CommonData.yaml#/components/responses/400'
'401': Reference 'TS29571_CommonData.yaml#/components/responses/401'
'403': Reference 'TS29571_CommonData.yaml#/components/responses/403'
'404': Reference 'TS29571_CommonData.yaml#/components/responses/404'
'411': Reference 'TS29571_CommonData.yaml#/components/responses/411'
'413': Reference 'TS29571_CommonData.yaml#/components/responses/413'
'415': Reference 'TS29571_CommonData.yaml#/components/responses/415'
'429': Reference 'TS29571_CommonData.yaml#/components/responses/429'
'500': Reference 'TS29571_CommonData.yaml#/components/responses/500'
'503': Reference 'TS29571_CommonData.yaml#/components/responses/503'
default: Reference 'TS29571_CommonData.yaml#/components/responses/default'
# End error scenarios PATCH