Get all valid structure
get
/structure-priority
This endpoint is used to get all valid Structure Priority records.
Request
Supported Media Types
- application/json
- application/xml
Query Parameters
-
customerId(optional): string
Pattern:
[a-zA-Z0-9]{1,20}
customerId need to be set to fetch structures for particular customer -
includecloseandunauth(optional): boolean
includecloseandunauth need to be set to fetch summary record, default value is false
-
limit(optional): integer
limit is maximum no of records to be fetched
-
offset(optional): integer
offset is starting no of records to be fetched
-
structureId(optional): string
Pattern:
[A-Z0-9]{1,30}
structureId need to be set to fetch structures for particular customer
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns message of success or failure
Headers
Root Schema : LmmTmStructurePriorityCollection
Type:
object
Collection of structure priority.
Show Source
Nested Schema : GenericDto
Match All
Show Source
-
object
GenericDto-allOf[0]
Discriminator:
resource_type
Nested Schema : GenericDto-allOf[0]
Type:
object
Discriminator:
resource_type
Nested Schema : LmmTmStructurePriorityDTO-allOf[1]
Type:
Show Source
object
-
customerId(optional):
string
Maximum Length:
20
Customer ID -
customerName(optional):
string
Maximum Length:
105
Customer Name -
id(optional):
string
Maximum Length:
36
ID -
structureId(optional):
string
Maximum Length:
30
Structure ID -
structurePriority(optional):
integer
Minimum Value:
1
Structure Priority
400 Response
Malformed syntax.
401 Response
Request does not have sufficient credentials.
403 Response
Request is not authorized.
405 Response
Invalid input
500 Response
Internal error