Vendor Request Partner Contact¶
Get A Resource By ID¶
HTTP Request
GET /api/v1/vendor-request-partner-contact/{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 "createdPartnerContactDisplayId": "string",
21 "name": "string",
22 "email": "string",
23 "phone": "string",
24 "position": "string",
25 "address": "string",
26 "group": "string",
27 "buildingName": "string",
28 "fax": "string",
29 "erpSystem": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "type": "NAKISA",
35 "sapVersion": "ECC_EHP5"
36 },
37 "partnerContact": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string"
42 },
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52}
Update A Resource¶
HTTP Request
PUT /api/v1/vendor-request-partner-contact/{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 contact information for the specified vendor partner, including name, email, phone number, and any relevant notes. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "changeType": "ADD",
5 "vendorRequestId": 0,
6 "vendorRequestDisplayId": "string",
7 "createdPartnerContactDisplayId": "string",
8 "name": "string",
9 "email": "string",
10 "phone": "string",
11 "position": "string",
12 "address": "string",
13 "group": "string",
14 "buildingName": "string",
15 "fax": "string",
16 "erpSystem": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "type": "NAKISA",
22 "sapVersion": "ECC_EHP5"
23 },
24 "partnerContact": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string"
29 },
30 "allowsSystemGenerateNewId": true,
31 "numberRangeIdentifierValue": "string",
32 "numberRangeIdentifierType": {
33 "name": "string"
34 },
35 "numberRangeType": {
36 "name": "string"
37 }
38}
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 "createdPartnerContactDisplayId": "string",
21 "name": "string",
22 "email": "string",
23 "phone": "string",
24 "position": "string",
25 "address": "string",
26 "group": "string",
27 "buildingName": "string",
28 "fax": "string",
29 "erpSystem": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "type": "NAKISA",
35 "sapVersion": "ECC_EHP5"
36 },
37 "partnerContact": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string"
42 },
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52}
Delete A Single Resource¶
HTTP Request
DELETE /api/v1/vendor-request-partner-contact/{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-contact/{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 updated contact information and relevant details for the specified vendor partner, facilitating effective communication and relationship management. |
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 "createdPartnerContactDisplayId": "string",
21 "name": "string",
22 "email": "string",
23 "phone": "string",
24 "position": "string",
25 "address": "string",
26 "group": "string",
27 "buildingName": "string",
28 "fax": "string",
29 "erpSystem": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "type": "NAKISA",
35 "sapVersion": "ECC_EHP5"
36 },
37 "partnerContact": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string"
42 },
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52}
Bulk Create-Or-Update Resources¶
HTTP Request
PUT /api/v1/vendor-request-partner-contact/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 an array of vendor partner contact details for bulk creation or updates, ensuring efficient management of vendor relationships. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "changeType": "ADD",
6 "vendorRequestId": 0,
7 "vendorRequestDisplayId": "string",
8 "createdPartnerContactDisplayId": "string",
9 "name": "string",
10 "email": "string",
11 "phone": "string",
12 "position": "string",
13 "address": "string",
14 "group": "string",
15 "buildingName": "string",
16 "fax": "string",
17 "erpSystem": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "type": "NAKISA",
23 "sapVersion": "ECC_EHP5"
24 },
25 "partnerContact": {
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]
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 "createdPartnerContactDisplayId": "string",
22 "name": "string",
23 "email": "string",
24 "phone": "string",
25 "position": "string",
26 "address": "string",
27 "group": "string",
28 "buildingName": "string",
29 "fax": "string",
30 "erpSystem": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "type": "NAKISA",
36 "sapVersion": "ECC_EHP5"
37 },
38 "partnerContact": {
39 "id": 0,
40 "displayId": "string",
41 "status": "CREATED",
42 "name": "string"
43 },
44 "allowsSystemGenerateNewId": true,
45 "numberRangeIdentifierValue": "string",
46 "numberRangeIdentifierType": {
47 "name": "string"
48 },
49 "numberRangeType": {
50 "name": "string"
51 }
52 }
53 ]
54}
Create Or Update A Resource¶
HTTP Request
PUT /api/v1/vendor-request-partner-contact/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 contact information, including name, email, phone number, and associated metadata for creating or updating contact records. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "changeType": "ADD",
5 "vendorRequestId": 0,
6 "vendorRequestDisplayId": "string",
7 "createdPartnerContactDisplayId": "string",
8 "name": "string",
9 "email": "string",
10 "phone": "string",
11 "position": "string",
12 "address": "string",
13 "group": "string",
14 "buildingName": "string",
15 "fax": "string",
16 "erpSystem": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "type": "NAKISA",
22 "sapVersion": "ECC_EHP5"
23 },
24 "partnerContact": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string"
29 },
30 "allowsSystemGenerateNewId": true,
31 "numberRangeIdentifierValue": "string",
32 "numberRangeIdentifierType": {
33 "name": "string"
34 },
35 "numberRangeType": {
36 "name": "string"
37 }
38}
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 "createdPartnerContactDisplayId": "string",
21 "name": "string",
22 "email": "string",
23 "phone": "string",
24 "position": "string",
25 "address": "string",
26 "group": "string",
27 "buildingName": "string",
28 "fax": "string",
29 "erpSystem": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "type": "NAKISA",
35 "sapVersion": "ECC_EHP5"
36 },
37 "partnerContact": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string"
42 },
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52}
Bulk-Update Resources¶
HTTP Request
PUT /api/v1/vendor-request-partner-contact/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 contact details for bulk updates, including relevant identifiers and contact information. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "changeType": "ADD",
6 "vendorRequestId": 0,
7 "vendorRequestDisplayId": "string",
8 "createdPartnerContactDisplayId": "string",
9 "name": "string",
10 "email": "string",
11 "phone": "string",
12 "position": "string",
13 "address": "string",
14 "group": "string",
15 "buildingName": "string",
16 "fax": "string",
17 "erpSystem": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "type": "NAKISA",
23 "sapVersion": "ECC_EHP5"
24 },
25 "partnerContact": {
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]
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 "createdPartnerContactDisplayId": "string",
22 "name": "string",
23 "email": "string",
24 "phone": "string",
25 "position": "string",
26 "address": "string",
27 "group": "string",
28 "buildingName": "string",
29 "fax": "string",
30 "erpSystem": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "type": "NAKISA",
36 "sapVersion": "ECC_EHP5"
37 },
38 "partnerContact": {
39 "id": 0,
40 "displayId": "string",
41 "status": "CREATED",
42 "name": "string"
43 },
44 "allowsSystemGenerateNewId": true,
45 "numberRangeIdentifierValue": "string",
46 "numberRangeIdentifierType": {
47 "name": "string"
48 },
49 "numberRangeType": {
50 "name": "string"
51 }
52 }
53 ]
54}
Bulk-Create Resources¶
HTTP Request
POST /api/v1/vendor-request-partner-contact/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 partner contact information, including names, email addresses, and phone numbers, for bulk processing and management. |
Body Parameters
1[
2 {
3 "id": 0,
4 "displayId": "string",
5 "changeType": "ADD",
6 "vendorRequestId": 0,
7 "vendorRequestDisplayId": "string",
8 "createdPartnerContactDisplayId": "string",
9 "name": "string",
10 "email": "string",
11 "phone": "string",
12 "position": "string",
13 "address": "string",
14 "group": "string",
15 "buildingName": "string",
16 "fax": "string",
17 "erpSystem": {
18 "id": 0,
19 "displayId": "string",
20 "status": "CREATED",
21 "name": "string",
22 "type": "NAKISA",
23 "sapVersion": "ECC_EHP5"
24 },
25 "partnerContact": {
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]
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 "createdPartnerContactDisplayId": "string",
22 "name": "string",
23 "email": "string",
24 "phone": "string",
25 "position": "string",
26 "address": "string",
27 "group": "string",
28 "buildingName": "string",
29 "fax": "string",
30 "erpSystem": {
31 "id": 0,
32 "displayId": "string",
33 "status": "CREATED",
34 "name": "string",
35 "type": "NAKISA",
36 "sapVersion": "ECC_EHP5"
37 },
38 "partnerContact": {
39 "id": 0,
40 "displayId": "string",
41 "status": "CREATED",
42 "name": "string"
43 },
44 "allowsSystemGenerateNewId": true,
45 "numberRangeIdentifierValue": "string",
46 "numberRangeIdentifierType": {
47 "name": "string"
48 },
49 "numberRangeType": {
50 "name": "string"
51 }
52 }
53 ]
54}
Bulk-Delete Resources¶
HTTP Request
DELETE /api/v1/vendor-request-partner-contact/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 partner contact identifiers to facilitate the bulk deletion of associated records. |
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-contact/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 search criteria for vendor partner contact information, including relevant identifiers and filters to facilitate efficient data retrieval. |
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 "createdPartnerContactDisplayIdLike": "string",
20 "nameLike": "string",
21 "emailLike": "string",
22 "phoneLike": "string",
23 "positionLike": "string",
24 "addressLike": "string",
25 "groupLike": "string",
26 "buildingNameLike": "string",
27 "faxLike": "string",
28 "partnerContactIdEqual": 0,
29 "partnerContactDisplayIdLike": "string",
30 "changeTypeEqual": "ADD",
31 "changeTypeIn": [
32 "ADD"
33 ],
34 "vendorRequestIdEqual": 0,
35 "vendorRequestDisplayIdLike": "string"
36}
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 "createdPartnerContactDisplayId": "string",
26 "name": "string",
27 "email": "string",
28 "phone": "string",
29 "position": "string",
30 "address": "string",
31 "group": "string",
32 "buildingName": "string",
33 "fax": "string",
34 "erpSystem": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "type": "NAKISA",
40 "sapVersion": "ECC_EHP5"
41 },
42 "partnerContact": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string"
47 },
48 "allowsSystemGenerateNewId": true,
49 "numberRangeIdentifierValue": "string",
50 "numberRangeIdentifierType": {
51 "name": "string"
52 },
53 "numberRangeType": {
54 "name": "string"
55 }
56 }
57 ],
58 "number": 0,
59 "sort": {
60 "unsorted": true,
61 "sorted": true,
62 "empty": true
63 },
64 "first": true,
65 "last": true,
66 "empty": true
67}
List All Resources¶
HTTP Request
GET /api/v1/vendor-request-partner-contact
📋 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 of the vendor request partner contact retrieval should be paginated for improved data management and user experience. |
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 "createdPartnerContactDisplayId": "string",
26 "name": "string",
27 "email": "string",
28 "phone": "string",
29 "position": "string",
30 "address": "string",
31 "group": "string",
32 "buildingName": "string",
33 "fax": "string",
34 "erpSystem": {
35 "id": 0,
36 "displayId": "string",
37 "status": "CREATED",
38 "name": "string",
39 "type": "NAKISA",
40 "sapVersion": "ECC_EHP5"
41 },
42 "partnerContact": {
43 "id": 0,
44 "displayId": "string",
45 "status": "CREATED",
46 "name": "string"
47 },
48 "allowsSystemGenerateNewId": true,
49 "numberRangeIdentifierValue": "string",
50 "numberRangeIdentifierType": {
51 "name": "string"
52 },
53 "numberRangeType": {
54 "name": "string"
55 }
56 }
57 ],
58 "number": 0,
59 "sort": {
60 "unsorted": true,
61 "sorted": true,
62 "empty": true
63 },
64 "first": true,
65 "last": true,
66 "empty": true
67}
Create A Resource¶
HTTP Request
POST /api/v1/vendor-request-partner-contact
📋 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 contact information, including name, email, phone number, and relevant business details for establishing communication. |
Body Parameters
1{
2 "id": 0,
3 "displayId": "string",
4 "changeType": "ADD",
5 "vendorRequestId": 0,
6 "vendorRequestDisplayId": "string",
7 "createdPartnerContactDisplayId": "string",
8 "name": "string",
9 "email": "string",
10 "phone": "string",
11 "position": "string",
12 "address": "string",
13 "group": "string",
14 "buildingName": "string",
15 "fax": "string",
16 "erpSystem": {
17 "id": 0,
18 "displayId": "string",
19 "status": "CREATED",
20 "name": "string",
21 "type": "NAKISA",
22 "sapVersion": "ECC_EHP5"
23 },
24 "partnerContact": {
25 "id": 0,
26 "displayId": "string",
27 "status": "CREATED",
28 "name": "string"
29 },
30 "allowsSystemGenerateNewId": true,
31 "numberRangeIdentifierValue": "string",
32 "numberRangeIdentifierType": {
33 "name": "string"
34 },
35 "numberRangeType": {
36 "name": "string"
37 }
38}
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 "createdPartnerContactDisplayId": "string",
21 "name": "string",
22 "email": "string",
23 "phone": "string",
24 "position": "string",
25 "address": "string",
26 "group": "string",
27 "buildingName": "string",
28 "fax": "string",
29 "erpSystem": {
30 "id": 0,
31 "displayId": "string",
32 "status": "CREATED",
33 "name": "string",
34 "type": "NAKISA",
35 "sapVersion": "ECC_EHP5"
36 },
37 "partnerContact": {
38 "id": 0,
39 "displayId": "string",
40 "status": "CREATED",
41 "name": "string"
42 },
43 "allowsSystemGenerateNewId": true,
44 "numberRangeIdentifierValue": "string",
45 "numberRangeIdentifierType": {
46 "name": "string"
47 },
48 "numberRangeType": {
49 "name": "string"
50 }
51 }
52}