SAP Posting Bot SettingΒΆ
SAP Posting Bot Setting - GetΒΆ
HTTP Request
GET /api/v1/sap-posting-bot/spb-settings/{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 |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "erpSystem": {
17 "id": 0,
18 "displayId": "string"
19 },
20 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
21 "value": "string"
22 }
23}
SAP Posting Bot Setting - UpdateΒΆ
HTTP Request
PUT /api/v1/sap-posting-bot/spb-settings/{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 |
none |
Body Parameters
1{
2 "id": 0,
3 "erpSystem": {
4 "id": 0,
5 "displayId": "string"
6 },
7 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
8 "value": "string"
9}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "erpSystem": {
17 "id": 0,
18 "displayId": "string"
19 },
20 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
21 "value": "string"
22 }
23}
SAP Posting Bot Setting - Create Or UpdateΒΆ
HTTP Request
PUT /api/v1/sap-posting-bot/spb-settings/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 |
none |
Body Parameters
1{
2 "id": 0,
3 "erpSystem": {
4 "id": 0,
5 "displayId": "string"
6 },
7 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
8 "value": "string"
9}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "erpSystem": {
17 "id": 0,
18 "displayId": "string"
19 },
20 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
21 "value": "string"
22 }
23}
SAP Posting Bot Setting - Create Or Update BulkΒΆ
HTTP Request
PUT /api/v1/sap-posting-bot/spb-settings/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 |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "erpSystem": {
5 "id": 0,
6 "displayId": "string"
7 },
8 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
9 "value": "string"
10 }
11]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "erpSystem": {
18 "id": 0,
19 "displayId": "string"
20 },
21 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
22 "value": "string"
23 }
24 ]
25}
SAP Posting Bot Setting - Bulk UpdateΒΆ
HTTP Request
PUT /api/v1/sap-posting-bot/spb-settings/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 |
none |
Body Parameters
1[
2 {
3 "id": 0,
4 "erpSystem": {
5 "id": 0,
6 "displayId": "string"
7 },
8 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
9 "value": "string"
10 }
11]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": [
15 {
16 "id": 0,
17 "erpSystem": {
18 "id": 0,
19 "displayId": "string"
20 },
21 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
22 "value": "string"
23 }
24 ]
25}
SAP Posting Bot Setting - SearchΒΆ
HTTP Request
POST /api/v1/sap-posting-bot/spb-settings/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 |
none |
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 "systemIdIn": [
16 0
17 ],
18 "systemIdEqual": 0,
19 "systemDisplayIdLike": "string",
20 "spbSettingTypeEqual": "DUPLICATE_CONSISTENCY_START_DATE",
21 "spbSettingTypeIn": [
22 "DUPLICATE_CONSISTENCY_START_DATE"
23 ],
24 "valueEqual": "string",
25 "valueLike": "string"
26}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 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 "erpSystem": {
22 "id": 0,
23 "displayId": "string"
24 },
25 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
26 "value": "string"
27 }
28 ],
29 "number": 0,
30 "sort": {
31 "unsorted": true,
32 "sorted": true,
33 "empty": true
34 },
35 "first": true,
36 "last": true,
37 "empty": true
38}
SAP Posting Bot Setting - Find AllΒΆ
HTTP Request
GET /api/v1/sap-posting-bot/spb-settings
π 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 |
none |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 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 "erpSystem": {
22 "id": 0,
23 "displayId": "string"
24 },
25 "spbSettingType": "DUPLICATE_CONSISTENCY_START_DATE",
26 "value": "string"
27 }
28 ],
29 "number": 0,
30 "sort": {
31 "unsorted": true,
32 "sorted": true,
33 "empty": true
34 },
35 "first": true,
36 "last": true,
37 "empty": true
38}