Description
Provides a facility to create a new area in the hierarchy under an existing department.
URL
https://apiprod.pdsglobal.com/V2/api/area/V1
Note: There are two non-production environments that can be used for testing.
Request
Type
POST
Headers
Content-Type = application/json
Parameters
Mandatory parameters are denoted by *
*
api_key: string(50)
This is required for authentication. It is used to identify the user and determine access to the system. If you do not have your API key please contact PDS Support (support@pdsglobal.com).
*
departmentId: integer
This is the unique identifier (primary key) for the department. This can be obtained from the hierarchy or the Area Details API.
*
areaTypeId: integer
Primary key of the Area Type. Defines the general equipment type for the area, such as Transfer Chute or Screens. This is configured in the Area Types dialog. The ID values can be retrieved from the Area Types API.
Body
|
Object: CreateArea |
|
|
name* - string(50) |
|
|
functionalLocation - string(50) A functional location can be added to reference the group to external software like SAP. This is just free text, not a link. |
Response
Body
|
Object: ResponseEntity<string> |
|
|
areaId: integer The Id (primary key) value of the newly created area. |
Response Status Code
See HTTP Response Codes and Errors
Examples
URL:
https://apiprod.pdsglobal.com/V2/api/area/V1&api_key=ABC123&groupId=1&areaTypeId=1
Request Body:
{
"name":"Test 1 Area",
"functionalLocation":"Test 1 Area functional location"
}
Response Body:
{
"areaId": 140
}