How do I call the party_counterparties endpoints over HTTP?
Table of Contents
- 1. Endpoints
- 1.1.
GET /api/v1/reference-data/party_counterparties - 1.2.
GET /api/v1/reference-data/party_counterparties/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000 - 1.3.
POST /api/v1/reference-data/party_counterparties/get-many - 1.4.
POST /api/v1/reference-data/party_counterparties - 1.5.
PUT /api/v1/reference-data/party_counterparties - 1.6.
POST /api/v1/reference-data/party_counterparties/put-many - 1.7.
DELETE /api/v1/reference-data/party_counterparties/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000 - 1.8.
POST /api/v1/reference-data/party_counterparties/delete-many - 1.9.
GET /api/v1/reference-data/party_counterparties/by-party-id/00000000-0000-0000-0000-000000000000 - 1.10.
GET /api/v1/reference-data/party_counterparties/by-counterparty-id/00000000-0000-0000-0000-000000000000
- 1.1.
This file documents the party_counterparties resource over HTTP, one section per endpoint. Every section exports its own Hurl file into projects/ores.http/scripts/library/. Running a file sends that one request, so a failure names the endpoint it came from.
1. Endpoints
1.1. GET /api/v1/reference-data/party_counterparties
List party counterparties. It needs a session.
It forwards to refdata.v1.party_counterparties.list.
The request is:
GET /api/v1/reference-data/party_counterparties
GET {{base_url}}/api/v1/reference-data/party_counterparties
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.2. GET /api/v1/reference-data/party_counterparties/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
Get one party counterparty. It needs a session.
It forwards to refdata.v1.party_counterparties.get.
The request is:
GET /api/v1/reference-data/party_counterparties/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
GET {{base_url}}/api/v1/reference-data/party_counterparties/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.3. POST /api/v1/reference-data/party_counterparties/get-many
Get many party counterparties. It needs a session.
It forwards to refdata.v1.party_counterparties.get_many.
The request is:
POST /api/v1/reference-data/party_counterparties/get-many
POST {{base_url}}/api/v1/reference-data/party_counterparties/get-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.4. POST /api/v1/reference-data/party_counterparties
Create one party counterparty. It needs a session.
It forwards to refdata.v1.party_counterparties.put.
The request is:
POST /api/v1/reference-data/party_counterparties
POST {{base_url}}/api/v1/reference-data/party_counterparties
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.5. PUT /api/v1/reference-data/party_counterparties
Replace one party counterparty. It needs a session.
It forwards to refdata.v1.party_counterparties.put.
The request is:
PUT /api/v1/reference-data/party_counterparties
PUT {{base_url}}/api/v1/reference-data/party_counterparties
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.6. POST /api/v1/reference-data/party_counterparties/put-many
Write many party counterparties. It needs a session.
It forwards to refdata.v1.party_counterparties.put_many.
The request is:
POST /api/v1/reference-data/party_counterparties/put-many
POST {{base_url}}/api/v1/reference-data/party_counterparties/put-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.7. DELETE /api/v1/reference-data/party_counterparties/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
Delete one party counterparty. It needs a session.
It forwards to refdata.v1.party_counterparties.delete.
The request is:
DELETE /api/v1/reference-data/party_counterparties/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
DELETE {{base_url}}/api/v1/reference-data/party_counterparties/00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.8. POST /api/v1/reference-data/party_counterparties/delete-many
Delete many party counterparties. It needs a session.
It forwards to refdata.v1.party_counterparties.delete_many.
The request is:
POST /api/v1/reference-data/party_counterparties/delete-many
POST {{base_url}}/api/v1/reference-data/party_counterparties/delete-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.9. GET /api/v1/reference-data/party_counterparties/by-party-id/00000000-0000-0000-0000-000000000000
List the party counterparties that reference one party id. It needs a session.
It forwards to refdata.v1.party_counterparties.list_by_party_id.
The request is:
GET /api/v1/reference-data/party_counterparties/by-party-id/00000000-0000-0000-0000-000000000000
GET {{base_url}}/api/v1/reference-data/party_counterparties/by-party-id/00000000-0000-0000-0000-000000000000
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.10. GET /api/v1/reference-data/party_counterparties/by-counterparty-id/00000000-0000-0000-0000-000000000000
List the party counterparties that reference one counterparty id. It needs a session.
It forwards to refdata.v1.party_counterparties.list_by_counterparty_id.
The request is:
GET /api/v1/reference-data/party_counterparties/by-counterparty-id/00000000-0000-0000-0000-000000000000
GET {{base_url}}/api/v1/reference-data/party_counterparties/by-counterparty-id/00000000-0000-0000-0000-000000000000
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200