View all Units of Measures by Code
get
/api/restapi/unitsOfMeasure/code/{key}
This endpoint returns units of measure that meet the following requirements:
- The object has a code that matches the value of the {key} path parameter.
Request
Path Parameters
-
key(required): string
The user-specified identifier of a units of measure.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : List<ApiEntityUnitsOfMeasure>
Type:
array
Title:
Show Source
List<ApiEntityUnitsOfMeasure>
-
Array of:
object ApiEntityUnitsOfMeasure
Title:
ApiEntityUnitsOfMeasure
This entity represents a UnitsOfMeasure object, a unique UnitsOfMeasure object can be identified by the following combinations of the fields.- unitOfMeasureId
- key,workspaceId
- key,workspaceCode
Nested Schema : ApiEntityUnitsOfMeasure
Type:
object
Title:
ApiEntityUnitsOfMeasure
This entity represents a UnitsOfMeasure object, a unique UnitsOfMeasure object can be identified by the following combinations of the fields.
Show Source
- unitOfMeasureId
- key,workspaceId
- key,workspaceCode
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the units of measure and the workspace. Possible values are Owned and Inherited. -
displayName: string
Minimum Length:
0
Maximum Length:255
The name of the unit of measure. -
key: string
Minimum Length:
0
Maximum Length:60
The abbreviation for the unit of measure name. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the unit of measure. -
unitOfMeasureId: integer
(int64)
The unique identifier for the unit of measure.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The code of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
204 Response
Successful operation with no content.
404 Response
The requested units of measure does not exist, or you do not have access to it.