Jump to

• Request
• Response
• Examples

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: 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 Top

Response

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.

Body ()

Root Schema : classCodes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ChildCount":{
            "title":"Child Count",
            "type":"integer",
            "description":"The child count of the parent.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClassCategory":{
            "title":"Classification Category",
            "maxLength":30,
            "type":"string",
            "description":"The class category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCategoryDescription":{
            "title":"Classification Category Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the class category.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCategoryGroup":{
            "maxLength":255,
            "type":"string",
            "description":"The class category group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCode":{
            "title":"Classification Code",
            "maxLength":30,
            "type":"string",
            "description":"The class code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCodeDescription":{
            "title":"Classification Code Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the class code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClassCodeMeaning":{
            "title":"Classification Code Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the class code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSourceId":{
            "title":"Data Source ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the data source.",
            "nullable":true,
            "x-queryable":true
        },
        "Depth":{
            "type":"integer",
            "description":"The depth level in the hierarchy tree.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupType":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup type of the code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Meaning":{
            "title":"Classification Category Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the class category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentDataSourceId":{
            "title":"Parent Data Source ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the parent data source.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentPk1Value":{
            "title":"Parent Primary Key 1 Value",
            "maxLength":100,
            "type":"string",
            "description":"The parent class category.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentPk2Value":{
            "title":"Parent Primary Key 2 Value",
            "maxLength":100,
            "type":"string",
            "description":"The parent class code.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentPk3Value":{
            "title":"Parent Primary Key 3 Value",
            "maxLength":100,
            "type":"string",
            "description":"The untie identifier of the parent view application.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentPk4Value":{
            "title":"Parent Primary Key 4 Value",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentPk5Value":{
            "title":"Parent Primary Key 5 Value",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentTreeLabelId":{
            "title":"Parent Tree Label ID",
            "maxLength":32,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentTreeNodeId":{
            "title":"Parent Tree Node ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the parent tree node.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk1EndValue":{
            "title":"Primary Key 1 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk1StartValue":{
            "title":"Classification Category",
            "maxLength":100,
            "type":"string",
            "description":"The class category.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk2EndValue":{
            "title":"Primary Key 2 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk2StartValue":{
            "title":"Classification Code",
            "maxLength":100,
            "type":"string",
            "description":"The class code.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk3EndValue":{
            "title":"Primary Key 3 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk3StartValue":{
            "title":"Primary Key 3 Start",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of view application.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk4EndValue":{
            "title":"Primary Key 4 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk4StartValue":{
            "title":"Primary Key 4 Start",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk5EndValue":{
            "title":"Primary Key 5 End",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "Pk5StartValue":{
            "title":"Primary Key 5 Start",
            "maxLength":100,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceTreeCode":{
            "title":"Reference Tree Code",
            "maxLength":30,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferenceTreeVersionId":{
            "title":"Reference Tree Version ID",
            "maxLength":32,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "SortOrder":{
            "title":"Sort Order",
            "type":"integer",
            "description":"The sort order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TreeCode":{
            "title":"Classification Category",
            "maxLength":30,
            "type":"string",
            "description":"The tree code.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TreeLabelId":{
            "title":"Tree Label ID",
            "maxLength":32,
            "type":"string",
            "description":"Not Applicable.",
            "nullable":true,
            "x-queryable":true
        },
        "TreeNodeId":{
            "title":"Tree Node ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the tree node.",
            "nullable":false,
            "x-queryable":true
        },
        "TreeStructureCode":{
            "title":"Tree Structure Code",
            "maxLength":30,
            "type":"string",
            "description":"The structure of the tree code.",
            "nullable":false,
            "x-queryable":true
        },
        "TreeVersionId":{
            "title":"Tree Version ID",
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the tree version.",
            "nullable":false,
            "x-queryable":true
        },
        "ViewApplicationId":{
            "type":"integer",
            "description":"The unique identifier of view application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to get a classification code by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/classCodes-{classCodeUniqID}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "ChildCount": 0,
    "CreatedBy": "-1",
    "CreationDate": "2009-12-14T02:06:18.142+00:00",
    "DataSourceId": "7AAE64FFCA0DE014E04044987CF06C3D",
    "Depth": 0,
    "LastUpdateDate": "2023-12-28T10:14:33.708+00:00",
    "LastUpdateLogin": "-1",
    "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
    "ParentDataSourceId": null,
    "ParentPk1Value": null,
    "ParentPk2Value": null,
    "ParentPk3Value": null,
    "ParentPk4Value": null,
    "ParentPk5Value": null,
    "ParentTreeLabelId": null,
    "ParentTreeNodeId": null,
    "Pk1EndValue": null,
    "Pk1StartValue": "1972 SIC",
    "Pk2EndValue": null,
    "Pk2StartValue": "0182",
    "Pk3EndValue": null,
    "Pk3StartValue": "0",
    "Pk4EndValue": null,
    "Pk4StartValue": null,
    "Pk5EndValue": null,
    "Pk5StartValue": null,
    "ReferenceTreeCode": null,
    "ReferenceTreeVersionId": null,
    "SortOrder": 0,
    "TreeCode": "1972 SIC",
    "TreeLabelId": null,
    "TreeNodeId": "7AAE65000CBAE014E04044987CF06C3D",
    "TreeStructureCode": "HZ_CLASSIFICATION_HIERARCHY",
    "TreeVersionId": "7AAE65000C71E014E04044987CF06C3D",
    "LookupType": "1972 SIC",
    "ViewApplicationId": 0,
    "ClassCategory": "1972 SIC",
    "ClassCode": "0182",
    "Meaning": "1972 SIC",
    "ClassCodeMeaning": "Under cover food crop growers",
    "ClassCategoryGroup": null,
    "ClassCategoryDescription": "1972 edition of United States Standard Industrial Classification codes",
    "ClassCodeDescription": "Under cover food crop growers",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/classCodes/00040000000831393732205349430000002037414145363530303043424145303134453034303434393837434630364333440000001B485A5F434C415353494649434154494F4E5F484945524152434859000000203741414536353030304337314530313445303430343439383743463036433344",
            "name": "classCodes",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/classCodes/00040000000831393732205349430000002037414145363530303043424145303134453034303434393837434630364333440000001B485A5F434C415353494649434154494F4E5F484945524152434859000000203741414536353030304337314530313445303430343439383743463036433344",
            "name": "classCodes",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/classCodes/00040000000831393732205349430000002037414145363530303043424145303134453034303434393837434630364333440000001B485A5F434C415353494649434154494F4E5F484945524152434859000000203741414536353030304337314530313445303430343439383743463036433344/lov/ClassCategoryGroupVA",
            "name": "ClassCategoryGroupVA",
            "kind": "collection"
        }
    ]
}

Back to Top