Vendor Request Partner Role¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/vendor-request-partner-role/{id}
📋 Description: Returns the single resource with the given ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Resource ID |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "changeType": "ADD",
18 "vendorRequestId": 0,
19 "vendorRequestDisplayId": "string",
20 "partnerRole": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string"
25 },
26 "allowsSystemGenerateNewId": true,
27 "numberRangeIdentifierValue": "string",
28 "numberRangeIdentifierType": {
29 "name": "string"
30 },
31 "numberRangeType": {
32 "name": "string"
33 }
34 }
35}
Update A Resource¶
HTTP Request
PUT /api/v1/vendor-request-partner-role/{id}
📋 Description: Fully replaces the resource with the given ID. All fields in the request body are applied.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Resource ID |
body |
body |
true |
Request body containing the updated vendor partner role information, including role details and associated permissions for effective vendor management. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "changeType": "ADD",
5 "vendorRequestId": 0,
6 "vendorRequestDisplayId": "string",
7 "partnerRole": {
8 "id": 0,
9 "displayId": "string",
10 "status": "CREATED",
11 "name": "string"
12 },
13 "allowsSystemGenerateNewId": true,
14 "numberRangeIdentifierValue": "string",
15 "numberRangeIdentifierType": {
16 "name": "string"
17 },
18 "numberRangeType": {
19 "name": "string"
20 }
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "changeType": "ADD",
18 "vendorRequestId": 0,
19 "vendorRequestDisplayId": "string",
20 "partnerRole": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string"
25 },
26 "allowsSystemGenerateNewId": true,
27 "numberRangeIdentifierValue": "string",
28 "numberRangeIdentifierType": {
29 "name": "string"
30 },
31 "numberRangeType": {
32 "name": "string"
33 }
34 }
35}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/vendor-request-partner-role/{id}
📋 Description: Permanently deletes the resource with the given ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Partially Update A Resource (Json Patch)¶
HTTP Request
PATCH /api/v1/vendor-request-partner-role/{id}
📋 Description: Applies a JSON Patch (RFC 6902) document to the resource with the given ID. Only the fields specified in the patch are modified; all other fields remain unchanged.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated vendor partner role information, including relevant attributes and status, to facilitate role modifications in the vendor management system. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "changeType": "ADD",
18 "vendorRequestId": 0,
19 "vendorRequestDisplayId": "string",
20 "partnerRole": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string"
25 },
26 "allowsSystemGenerateNewId": true,
27 "numberRangeIdentifierValue": "string",
28 "numberRangeIdentifierType": {
29 "name": "string"
30 },
31 "numberRangeType": {
32 "name": "string"
33 }
34 }
35}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/vendor-request-partner-role/createOrUpdate/bulk
📋 Description: Creates or updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response
errorslist. The response body always contains the successfully processed items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a list of vendor partner role details for bulk creation or updates, including relevant identifiers and attributes necessary for effective role management. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "changeType": "ADD",
6 "vendorRequestId": 0,
7 "vendorRequestDisplayId": "string",
8 "partnerRole": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "name": "string"
13 },
14 "allowsSystemGenerateNewId": true,
15 "numberRangeIdentifierValue": "string",
16 "numberRangeIdentifierType": {
17 "name": "string"
18 },
19 "numberRangeType": {
20 "name": "string"
21 }
22 }
23]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "changeType": "ADD",
19 "vendorRequestId": 0,
20 "vendorRequestDisplayId": "string",
21 "partnerRole": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string"
26 },
27 "allowsSystemGenerateNewId": true,
28 "numberRangeIdentifierValue": "string",
29 "numberRangeIdentifierType": {
30 "name": "string"
31 },
32 "numberRangeType": {
33 "name": "string"
34 }
35 }
36 ]
37}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/vendor-request-partner-role/createOrUpdate
📋 Description: Creates the resource if no matching record exists, or fully updates it if one is found. Idempotent: safe to call multiple times with the same payload.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the vendor partner role details, including identification information and associated permissions for effective role management. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "changeType": "ADD",
5 "vendorRequestId": 0,
6 "vendorRequestDisplayId": "string",
7 "partnerRole": {
8 "id": 0,
9 "displayId": "string",
10 "status": "CREATED",
11 "name": "string"
12 },
13 "allowsSystemGenerateNewId": true,
14 "numberRangeIdentifierValue": "string",
15 "numberRangeIdentifierType": {
16 "name": "string"
17 },
18 "numberRangeType": {
19 "name": "string"
20 }
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "changeType": "ADD",
18 "vendorRequestId": 0,
19 "vendorRequestDisplayId": "string",
20 "partnerRole": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string"
25 },
26 "allowsSystemGenerateNewId": true,
27 "numberRangeIdentifierValue": "string",
28 "numberRangeIdentifierType": {
29 "name": "string"
30 },
31 "numberRangeType": {
32 "name": "string"
33 }
34 }
35}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/vendor-request-partner-role/bulk
📋 Description: Updates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are updated; failed items are recorded in the response
errorslist. The response body always contains the successfully updated items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing a collection of vendor partner role assignments, including relevant identifiers and role specifications for bulk processing. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "changeType": "ADD",
6 "vendorRequestId": 0,
7 "vendorRequestDisplayId": "string",
8 "partnerRole": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "name": "string"
13 },
14 "allowsSystemGenerateNewId": true,
15 "numberRangeIdentifierValue": "string",
16 "numberRangeIdentifierType": {
17 "name": "string"
18 },
19 "numberRangeType": {
20 "name": "string"
21 }
22 }
23]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "changeType": "ADD",
19 "vendorRequestId": 0,
20 "vendorRequestDisplayId": "string",
21 "partnerRole": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string"
26 },
27 "allowsSystemGenerateNewId": true,
28 "numberRangeIdentifierValue": "string",
29 "numberRangeIdentifierType": {
30 "name": "string"
31 },
32 "numberRangeType": {
33 "name": "string"
34 }
35 }
36 ]
37}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/vendor-request-partner-role/bulk
📋 Description: Creates multiple resources in a single request. Partial success: each item is processed independently. Items that pass validation are persisted; failed items are recorded in the response
errorslist. The response body always contains the successfully created items alongside any per-item errors.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing an array of vendor role assignment data for bulk processing, including partner identifiers and associated role details. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "changeType": "ADD",
6 "vendorRequestId": 0,
7 "vendorRequestDisplayId": "string",
8 "partnerRole": {
9 "id": 0,
10 "displayId": "string",
11 "status": "CREATED",
12 "name": "string"
13 },
14 "allowsSystemGenerateNewId": true,
15 "numberRangeIdentifierValue": "string",
16 "numberRangeIdentifierType": {
17 "name": "string"
18 },
19 "numberRangeType": {
20 "name": "string"
21 }
22 }
23]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "displayId": "string",
18 "changeType": "ADD",
19 "vendorRequestId": 0,
20 "vendorRequestDisplayId": "string",
21 "partnerRole": {
22 "id": 0,
23 "displayId": "string",
24 "status": "CREATED",
25 "name": "string"
26 },
27 "allowsSystemGenerateNewId": true,
28 "numberRangeIdentifierValue": "string",
29 "numberRangeIdentifierType": {
30 "name": "string"
31 },
32 "numberRangeType": {
33 "name": "string"
34 }
35 }
36 ]
37}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/vendor-request-partner-role/bulk
📋 Description: Deletes multiple resources by ID in a single request. Partial success: each deletion is attempted independently. If one or more deletions fail (e.g. due to state constraints), the successfully deleted items are NOT rolled back. A
ValidationExceptioncontaining per-item errors is thrown after all items have been attempted, so the caller must inspect the error list to determine which IDs were not deleted.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
array[integer] |
true |
Request body containing an array of vendor request partner role identifiers to facilitate bulk deletion of associated roles. |
Body Parameters
1[
2 0
3]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {}
15}
Search Resources¶
HTTP Request
POST /api/v1/vendor-request-partner-role/search
📋 Description: Returns a paginated list of resources matching the given filter criteria. Pass null or an empty body to return all accessible records.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
page |
query |
integer |
false |
Zero-based page index (0..N) |
size |
query |
integer |
false |
The size of the page to be returned |
sort |
query |
array[string] |
false |
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported. |
body |
body |
false |
Request body containing the criteria for searching vendor partnership roles, including relevant filters and parameters to refine the search results. |
Default Values¶
Parameter |
Default |
Type |
|---|---|---|
page |
|
query |
size |
|
query |
sort |
|
query |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
page |
Min: 0 |
size |
Min: 1 |
Body Parameters
1{
2 "idIn": [
3 0
4 ],
5 "idEqual": 0,
6 "idLike": "string",
7 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
8 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdByLike": "string",
10 "createdByEqual": "string",
11 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
12 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedByLike": "string",
14 "modifiedByEqual": "string",
15 "displayIdIn": [
16 "string"
17 ],
18 "displayIdLike": "string",
19 "partnerRoleIdEqual": 0,
20 "partnerRoleDisplayIdLike": "string",
21 "changeTypeEqual": "ADD",
22 "changeTypeIn": [
23 "ADD"
24 ],
25 "vendorRequestIdEqual": 0,
26 "vendorRequestDisplayIdLike": "string"
27}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "changeType": "ADD",
23 "vendorRequestId": 0,
24 "vendorRequestDisplayId": "string",
25 "partnerRole": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string"
30 },
31 "allowsSystemGenerateNewId": true,
32 "numberRangeIdentifierValue": "string",
33 "numberRangeIdentifierType": {
34 "name": "string"
35 },
36 "numberRangeType": {
37 "name": "string"
38 }
39 }
40 ],
41 "number": 0,
42 "sort": {
43 "unsorted": true,
44 "sorted": true,
45 "empty": true
46 },
47 "first": true,
48 "last": true,
49 "empty": true
50}
List All Resources¶
HTTP Request
GET /api/v1/vendor-request-partner-role
📋 Description: Returns a paginated list of all accessible resources ordered by ID. Prefer POST /search for filtered queries.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
pageable |
query |
true |
Indicates whether the results should be returned in a paginated format, allowing for efficient data retrieval and improved user experience when accessing vendor request partner roles. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "totalPages": 0,
3 "totalElements": 0,
4 "pageable": {
5 "pageNumber": 0,
6 "unpaged": true,
7 "paged": true,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "displayId": "string",
22 "changeType": "ADD",
23 "vendorRequestId": 0,
24 "vendorRequestDisplayId": "string",
25 "partnerRole": {
26 "id": 0,
27 "displayId": "string",
28 "status": "CREATED",
29 "name": "string"
30 },
31 "allowsSystemGenerateNewId": true,
32 "numberRangeIdentifierValue": "string",
33 "numberRangeIdentifierType": {
34 "name": "string"
35 },
36 "numberRangeType": {
37 "name": "string"
38 }
39 }
40 ],
41 "number": 0,
42 "sort": {
43 "unsorted": true,
44 "sorted": true,
45 "empty": true
46 },
47 "first": true,
48 "last": true,
49 "empty": true
50}
Create A Resource¶
HTTP Request
POST /api/v1/vendor-request-partner-role
📋 Description: Creates a single resource. Returns the created resource with its generated ID.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the vendor partnership role details, including role specifications and associated metadata necessary for processing the vendor request. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "changeType": "ADD",
5 "vendorRequestId": 0,
6 "vendorRequestDisplayId": "string",
7 "partnerRole": {
8 "id": 0,
9 "displayId": "string",
10 "status": "CREATED",
11 "name": "string"
12 },
13 "allowsSystemGenerateNewId": true,
14 "numberRangeIdentifierValue": "string",
15 "numberRangeIdentifierType": {
16 "name": "string"
17 },
18 "numberRangeType": {
19 "name": "string"
20 }
21}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
||
409 |
Payment amount exceeds remaining invoice balance |
||
502 |
Downstream service call failed |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "source": {},
8 "errorMessage": "string",
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "displayId": "string",
17 "changeType": "ADD",
18 "vendorRequestId": 0,
19 "vendorRequestDisplayId": "string",
20 "partnerRole": {
21 "id": 0,
22 "displayId": "string",
23 "status": "CREATED",
24 "name": "string"
25 },
26 "allowsSystemGenerateNewId": true,
27 "numberRangeIdentifierValue": "string",
28 "numberRangeIdentifierType": {
29 "name": "string"
30 },
31 "numberRangeType": {
32 "name": "string"
33 }
34 }
35}