Get an unit of measure
get
/crmRestApi/resources/11.13.18.05/unitOfMeasures/{UomCode}
Request
Path Parameters
-
UomCode(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : unitOfMeasures-item-response
Type:
Show Source
object
-
Attribute1: string
Read Only:
true
Maximum Length:150
The attribute 1 of the unit of measure. -
Attribute10: string
Read Only:
true
Maximum Length:150
The attribute 10 of the unit of measure. -
Attribute11: string
Read Only:
true
Maximum Length:150
The attribute 11 of the unit of measure. -
Attribute12: string
Read Only:
true
Maximum Length:150
The attribute 12 of the unit of measure. -
Attribute13: string
Read Only:
true
Maximum Length:150
The attribute 13 of the unit of measure. -
Attribute14: string
Read Only:
true
Maximum Length:150
The attribute 14 of the unit of measure. -
Attribute15: string
Read Only:
true
Maximum Length:150
The attribute 15 of the unit of measure. -
Attribute2: string
Read Only:
true
Maximum Length:150
The attribute 2 of the unit of measure. -
Attribute3: string
Read Only:
true
Maximum Length:150
The attribute 3 of the unit of measure. -
Attribute4: string
Read Only:
true
Maximum Length:150
The attribute 4 of the unit of measure. -
Attribute5: string
Read Only:
true
Maximum Length:150
The attribute 5 of the unit of measure. -
Attribute6: string
Read Only:
true
Maximum Length:150
The attribute 6 of the unit of measure. -
Attribute7: string
Read Only:
true
Maximum Length:150
The attribute 7 of the unit of measure. -
Attribute8: string
Read Only:
true
Maximum Length:150
The attribute 8 of the unit of measure. -
Attribute9: string
Read Only:
true
Maximum Length:150
The attribute 9 of the unit of measure. -
AttributeCategory: string
Read Only:
true
Maximum Length:30
The attribute category of the unit of measure. -
BaseUomFlag: string
Read Only:
true
Maximum Length:1
The base UOM indicator of the unit of measure. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the unit of measure. -
CreationDate: string
(date-time)
Read Only:
true
The creation date of the unit of measure. -
Description: string
Title:
Description
Read Only:true
Maximum Length:50
The description of the unit of measure. -
DisableDate: string
(date)
Title:
End Date
Read Only:true
The disabled date of the unit of measure. -
JobDefinitionName: string
Read Only:
true
Maximum Length:100
The job definition name of the unit of measure. -
JobDefinitionPackage: string
Read Only:
true
Maximum Length:900
The job definition package of the unit of measure. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last updated date of the unit of measure. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the unit of measure. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The last updated login of the unit of measure. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number of the unit of measure. -
ObjectVersionNumber1: integer
(int32)
Read Only:
true
The object version number1 of the unit of measure. -
RequestId: integer
(int64)
Read Only:
true
The request identifier of the unit of measure. -
StandardPackFlag: string
Read Only:
true
Maximum Length:1
The standard pack flag of the unit of measure. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
The unit of measure of the unit of measure. -
UnitOfMeasureId: integer
(int64)
Read Only:
true
The unique identifier of the unit of measure. -
UomClass: string
Title:
UOM Class
Read Only:true
Maximum Length:10
The UOM class of the unit of measure. -
UomClass1: string
Read Only:
true
Maximum Length:10
The UOM class 1 of the unit of measure. -
UomClassTl: string
Title:
UOM Class
Read Only:true
Maximum Length:10
The UOM Class 2 of the unit of measure. -
UomCode: string
Title:
UOM Code
Read Only:true
Maximum Length:3
The UOM code of the unit of measure. -
UomPluralDesc: string
Title:
Plural Description
Read Only:true
Maximum Length:50
The UOM plural description of the unit of measure. -
UomReciprocalDesc: string
Title:
Reciprocal Description
Read Only:true
Maximum Length:50
The UOM reciprocal description of the unit of measure.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.