Get a classification code
get
/crmRestApi/resources/11.13.18.05/classCodes/{classCodesUniqID}
Request
Path Parameters
-
classCodesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- TreeCode, TreeNodeId, TreeStructureCode and TreeVersionId ---for the Class Codes resource and used to uniquely identify an instance of Class Codes. The client should not generate the hash key value. Instead, the client should query on the Class Codes collection resource with a filter on the primary key values in order to navigate to a specific instance of Class Codes.
For example: classCodes?q=TreeCode=<value1>;TreeNodeId=<value2>;TreeStructureCode=<value3>;TreeVersionId=<value4>
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:
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.
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(required):
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(required):
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 : classCodes-item-response
Type:
Show Source
object
-
ChildCount: integer
(int64)
Title:
Child Count
The child count of the parent. -
ClassCategory: string
Title:
Classification Category
Read Only:true
Maximum Length:30
The class category. -
ClassCategoryDescription: string
Title:
Classification Category Description
Read Only:true
Maximum Length:240
The description of the class category. -
ClassCategoryGroup: string
Read Only:
true
Maximum Length:255
The class category group. -
ClassCode: string
Title:
Classification Code
Read Only:true
Maximum Length:30
The class code. -
ClassCodeDescription: string
Title:
Classification Code Description
Read Only:true
Maximum Length:240
The description of the class code. -
ClassCodeMeaning: string
Title:
Classification Code Meaning
Read Only:true
Maximum Length:80
The meaning of the class code. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the row. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the row was created. -
DataSourceId: string
Title:
Data Source ID
Maximum Length:32
The unique identifier of the data source. -
Depth: integer
(int64)
The depth level in the hierarchy tree.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the row was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupType: string
Read Only:
true
Maximum Length:30
The lookup type of the code. -
Meaning: string
Title:
Classification Category Meaning
Read Only:true
Maximum Length:80
The meaning of the class category. -
ParentDataSourceId: string
Title:
Parent Data Source ID
Maximum Length:32
The unique identifier of the parent data source. -
ParentPk1Value: string
Title:
Parent Primary Key 1 Value
Maximum Length:100
The parent class category. -
ParentPk2Value: string
Title:
Parent Primary Key 2 Value
Maximum Length:100
The parent class code. -
ParentPk3Value: string
Title:
Parent Primary Key 3 Value
Maximum Length:100
The untie identifier of the parent view application. -
ParentPk4Value: string
Title:
Parent Primary Key 4 Value
Maximum Length:100
Not Applicable. -
ParentPk5Value: string
Title:
Parent Primary Key 5 Value
Maximum Length:100
Not Applicable. -
ParentTreeLabelId: string
Title:
Parent Tree Label ID
Maximum Length:32
Not Applicable. -
ParentTreeNodeId: string
Title:
Parent Tree Node ID
Maximum Length:32
The unique identifier of the parent tree node. -
Pk1EndValue: string
Title:
Primary Key 1 End
Maximum Length:100
Not Applicable. -
Pk1StartValue: string
Title:
Classification Category
Maximum Length:100
The class category. -
Pk2EndValue: string
Title:
Primary Key 2 End
Maximum Length:100
Not Applicable. -
Pk2StartValue: string
Title:
Classification Code
Maximum Length:100
The class code. -
Pk3EndValue: string
Title:
Primary Key 3 End
Maximum Length:100
Not Applicable. -
Pk3StartValue: string
Title:
Primary Key 3 Start
Maximum Length:100
The unique identifier of view application. -
Pk4EndValue: string
Title:
Primary Key 4 End
Maximum Length:100
Not Applicable. -
Pk4StartValue: string
Title:
Primary Key 4 Start
Maximum Length:100
Not Applicable. -
Pk5EndValue: string
Title:
Primary Key 5 End
Maximum Length:100
Not Applicable. -
Pk5StartValue: string
Title:
Primary Key 5 Start
Maximum Length:100
Not Applicable. -
ReferenceTreeCode: string
Title:
Reference Tree Code
Maximum Length:30
Not Applicable. -
ReferenceTreeVersionId: string
Title:
Reference Tree Version ID
Maximum Length:32
Not Applicable. -
SortOrder: integer
(int64)
Title:
Sort Order
The sort order. -
TreeCode: string
Title:
Classification Category
Maximum Length:30
The tree code. -
TreeLabelId: string
Title:
Tree Label ID
Maximum Length:32
Not Applicable. -
TreeNodeId: string
Title:
Tree Node ID
Maximum Length:32
The unique identifier of the tree node. -
TreeStructureCode: string
Title:
Tree Structure Code
Maximum Length:30
The structure of the tree code. -
TreeVersionId: string
Title:
Tree Version ID
Maximum Length:32
The unique identifier of the tree version. -
ViewApplicationId: integer
(int64)
Read Only:
true
The unique identifier of view application.
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.