SAP Authorization Object

SAP Authorization Object - Get

HTTP Request

GET /api/v1/sap-auth-objects/{id}

Interactive Demo

📋 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	OK	ResponseSapAuthorizationBatchDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "historyStatus": "LATEST",
    "validated": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Update

HTTP Request

PUT /api/v1/sap-auth-objects/{id}

Interactive Demo

📋 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	SapAuthorizationBatchDto	true	none

Body Parameters

{
  "id": 0,
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "historyStatus": "LATEST",
  "validated": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseSapAuthorizationBatchDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "historyStatus": "LATEST",
    "validated": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Validate Batch

HTTP Request

PUT /api/v1/sap-auth-objects/validate

Interactive Demo

Parameters

Name	In	Type	Required	Description
body	body	SapAuthorizationValidateRequestDto	true	none

Body Parameters

{
  "id": 0,
  "batchId": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseString

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": "string"
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Create Or Update Bulk

HTTP Request

PUT /api/v1/sap-auth-objects/createOrUpdate/bulk

Interactive Demo

📋 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 errors list. The response body always contains the successfully processed items alongside any per-item errors.

Parameters

Name	In	Type	Required	Description
body	body	SapAuthorizationBatchDto	true	none

Body Parameters

[
  {
    "id": 0,
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "historyStatus": "LATEST",
    "validated": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListSapAuthorizationBatchDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "historyStatus": "LATEST",
      "validated": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Create Or Update

HTTP Request

PUT /api/v1/sap-auth-objects/createOrUpdate

Interactive Demo

📋 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	SapAuthorizationBatchDto	true	none

Body Parameters

{
  "id": 0,
  "erpSystemId": 0,
  "erpSystemDisplayId": "string",
  "historyStatus": "LATEST",
  "validated": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseSapAuthorizationBatchDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "historyStatus": "LATEST",
    "validated": true
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Bulk Update

HTTP Request

PUT /api/v1/sap-auth-objects/bulk

Interactive Demo

📋 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 errors list. The response body always contains the successfully updated items alongside any per-item errors.

Parameters

Name	In	Type	Required	Description
body	body	SapAuthorizationBatchDto	true	none

Body Parameters

[
  {
    "id": 0,
    "erpSystemId": 0,
    "erpSystemDisplayId": "string",
    "historyStatus": "LATEST",
    "validated": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListSapAuthorizationBatchDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "historyStatus": "LATEST",
      "validated": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Search

HTTP Request

POST /api/v1/sap-auth-objects/search

Interactive Demo

📋 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	SapAuthorizationBatchDtoFilter	false	none

Default Values

Parameter	Default	Type
page	0	query
size	100	query
sort	["createdAt,ASC"]	query

Parameter Constraints

Parameter	Constraints
page	Min: 0
size	Min: 1

Body Parameters

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "erpSystemIdLike": "string",
  "erpSystemDisplayIdLike": "string",
  "historyStatusIn": [
    "LATEST"
  ],
  "validatedEqual": true
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageSapAuthorizationBatchDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "historyStatus": "LATEST",
      "validated": true
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Fetch Latest From SAP

HTTP Request

POST /api/v1/sap-auth-objects/fetch-latest

Interactive Demo

Parameters

Name	In	Type	Required	Description
body	body	SapAuthorizationFetchRequestDto	true	none

Body Parameters

{
  "id": 0,
  "erpSystemId": 0,
  "retentionLimit": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseSapAuthorizationFetchResponseDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "sapAuthObjectsInserted": 0,
    "batchesUpdated": 0,
    "sapAuthObjectsDeleted": 0,
    "batchesDeleted": 0,
    "newBatchId": 0,
    "message": "string"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Get SAP Auth Objects By Batch ID

HTTP Request

POST /api/v1/sap-auth-objects/batches/{erpSystemId}/{batchId}

Interactive Demo

Parameters

Name	In	Type	Required	Description
erpSystemId	path	integer(int64)	true	none
batchId	path	integer(int64)	true	none
body	body	object	true	none
» filter	body	SapAuthorizationObjectDtoFilter	false	none
»» idIn	body	[integer]	false	none
»» idEqual	body	integer(int64)	false	none
»» idLike	body	string	false	none
»» batchIdLike	body	string	false	none
»» objectLike	body	string	false	none
»» authLike	body	string	false	none
»» fieldLike	body	string	false	none
»» vonLike	body	string	false	none
»» bisLike	body	string	false	none
» pageable	body	Pageable	false	Data transfer object representing a paginated collection of financial entities within an organization’s hierarchical structure, facilitating efficient retrieval and management of organizational data.
»» page	body	integer(int32)	false	Page number for pagination
»» size	body	integer(int32)	false	Number of items per page
»» sort	body	[string]	false	Sort order specification

Parameter Constraints

Parameter	Constraints
»» page	Min: 0
»» size	Min: 1

Body Parameters

{
  "filter": {
    "idIn": [
      0
    ],
    "idEqual": 0,
    "idLike": "string",
    "batchIdLike": "string",
    "objectLike": "string",
    "authLike": "string",
    "fieldLike": "string",
    "vonLike": "string",
    "bisLike": "string"
  },
  "pageable": {
    "page": 0,
    "size": 1,
    "sort": [
      "string"
    ]
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageSapAuthorizationObjectDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "batchId": 0,
      "object": "string",
      "auth": "string",
      "field": "string",
      "von": "string",
      "bis": "string"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Export SAP Authorization Objects To Excel

HTTP Request

GET /api/v1/sap-auth-objects/batches/{erpSystemId}/{batchId}/export

Interactive Demo

Parameters

Name	In	Type	Required	Description
erpSystemId	path	integer(int64)	true	none
batchId	path	integer(int64)	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	None

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - List Batches

HTTP Request

GET /api/v1/sap-auth-objects/batches/{erpSystemId}

Interactive Demo

Parameters

Name	In	Type	Required	Description
erpSystemId	path	integer(int64)	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListSapAuthorizationBatchDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "historyStatus": "LATEST",
      "validated": true
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

SAP Authorization Object - Find All

HTTP Request

GET /api/v1/sap-auth-objects

Interactive Demo

📋 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	Pageable	true	none

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageSapAuthorizationBatchDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "pageNumber": 0,
    "paged": true,
    "pageSize": 0,
    "unpaged": true,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "erpSystemId": 0,
      "erpSystemDisplayId": "string",
      "historyStatus": "LATEST",
      "validated": true
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---