How do I call the parties endpoints over HTTP?
Table of Contents
- 1. Endpoints
- 1.1.
GET /api/v1/reference-data/parties - 1.2.
GET /api/v1/reference-data/parties/__none__ - 1.3.
POST /api/v1/reference-data/parties/get-many - 1.4.
POST /api/v1/reference-data/parties - 1.5.
PUT /api/v1/reference-data/parties - 1.6.
POST /api/v1/reference-data/parties/put-many - 1.7.
DELETE /api/v1/reference-data/parties/__none__ - 1.8.
POST /api/v1/reference-data/parties/delete-many - 1.9.
GET /api/v1/reference-data/parties/__none__/versions - 1.10.
GET /api/v1/reference-data/parties/__none__/versions/0
- 1.1.
This file documents the parties 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/parties
List parties. It needs a session.
It forwards to refdata.v1.parties.list.
The request is:
GET /api/v1/reference-data/parties
GET {{base_url}}/api/v1/reference-data/parties
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.2. GET /api/v1/reference-data/parties/__none__
Get one party. It needs a session.
It forwards to refdata.v1.parties.get.
The request is:
GET /api/v1/reference-data/parties/__none__
GET {{base_url}}/api/v1/reference-data/parties/__none__
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.3. POST /api/v1/reference-data/parties/get-many
Get many parties. It needs a session.
It forwards to refdata.v1.parties.get_many.
The request is:
POST /api/v1/reference-data/parties/get-many
POST {{base_url}}/api/v1/reference-data/parties/get-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.4. POST /api/v1/reference-data/parties
Create one party. It needs a session.
It forwards to refdata.v1.parties.put.
The request is:
POST /api/v1/reference-data/parties
POST {{base_url}}/api/v1/reference-data/parties
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.5. PUT /api/v1/reference-data/parties
Replace one party. It needs a session.
It forwards to refdata.v1.parties.put.
The request is:
PUT /api/v1/reference-data/parties
PUT {{base_url}}/api/v1/reference-data/parties
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.6. POST /api/v1/reference-data/parties/put-many
Write many parties. It needs a session.
It forwards to refdata.v1.parties.put_many.
The request is:
POST /api/v1/reference-data/parties/put-many
POST {{base_url}}/api/v1/reference-data/parties/put-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.7. DELETE /api/v1/reference-data/parties/__none__
Delete one party. It needs a session.
It forwards to refdata.v1.parties.delete.
The request is:
DELETE /api/v1/reference-data/parties/__none__
DELETE {{base_url}}/api/v1/reference-data/parties/__none__
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.8. POST /api/v1/reference-data/parties/delete-many
Delete many parties. It needs a session.
It forwards to refdata.v1.parties.delete_many.
The request is:
POST /api/v1/reference-data/parties/delete-many
POST {{base_url}}/api/v1/reference-data/parties/delete-many
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.9. GET /api/v1/reference-data/parties/__none__/versions
List the recorded versions of one party. It needs a session.
It forwards to refdata.v1.parties_versions.list.
The request is:
GET /api/v1/reference-data/parties/__none__/versions
GET {{base_url}}/api/v1/reference-data/parties/__none__/versions
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200
1.10. GET /api/v1/reference-data/parties/__none__/versions/0
Get one recorded version of one party. It needs a session.
It forwards to refdata.v1.parties_versions.get.
The request is:
GET /api/v1/reference-data/parties/__none__/versions/0
GET {{base_url}}/api/v1/reference-data/parties/__none__/versions/0
Accept: application/json
Authorization: Bearer {{token}}
HTTP 200