Jump to

• Request
• Response

Get one item class

get

/fscmRestApi/resources/11.13.18.05/itemClasses/{ItemClassId}

Request

Path Parameters

• ItemClassId(required): integer(int64)
  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 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 : itemClasses-item-response

Type: object

Show Source

• ChangeOrderTypeId: integer (int64)
  Unique identifier of the change order type used for the item class.
• DefaultItemClassFlag: boolean
  Title: Default Item Class

  Maximum Length: 1

  Default Value: false

  Default item classes for items created through import will be picked based on this option. Only one item class can have this option enabled.
• Description: string
  Title: Description

  Maximum Length: 240

  Description of the item class.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then the item class is enabled for use. If false, then the item class isn't enabled for use. The default value is true.
• InternalName: string
  Title: Internal Name

  Maximum Length: 80

  Internal name of the item class.
• ItemClass: string
  Title: Item Class

  Maximum Length: 80

  Name of the item class.
• ItemClassAttachmentCategories: array Attachment Categories
  Title: Attachment Categories

  ItemClass.AttachmentCategories
• ItemClassCode: string
  Title: Internal Name

  Maximum Length: 80

  Internal name of an item class.
• ItemClassId: integer (int64)
  Unique identifier for an item class.
• ItemClassPhases: array Lifecycle Phases
  Title: Lifecycle Phases

  ItemClass.Phases
• ItemClassType: string
  Maximum Length: 30

  Default Value: Item

  Type of item class.
• ItemCreationAllowedFlag: boolean
  Title: Item Creation Allowed

  Maximum Length: 1

  Default Value: true

  Contains one of the following values: true or false. If true, then items can be created in this item class. If false, then items can't be created in this item class. The default value is true.
• ItemDescriptionGenMethodCode: string
  Title: Item Description Generation Method

  Maximum Length: 30

  Default Value: P

  Specifies the item description generation method for the items of the item class.
• ItemDescriptionGenMethodValue: string
  Attribute used to specify the item description generation method for the items of the item class.
• ItemNumberGenMethodCode: string
  Title: Item Number Generation Method

  Maximum Length: 30

  Default Value: P

  Specifies the item number generation method for the items of the item class
• ItemNumberGenMethodValue: string
  An attribute used to specify the item number generation method for items created in the item class.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewItemRequestRequiredFlag: boolean
  Title: New Item Request Enabled

  Maximum Length: 1

  Default Value: false

  Contains one of the following values: true or false. If true, then a new item request is required for items of the item class. If false, then a new item request isn't required for items of the item class.
• ParentItemClass: string
  Maximum Length: 255

  Name of the parent item class.
• ParentItemClassDescription: string
  Read Only: true

  Maximum Length: 255

  Description of the parent item class.
• ParentItemClassId: integer (int64)
  Parent item class of the child item class.
• PublicFlag: boolean
  Title: Public

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then this item class can be used by all users. If false, this item class can't be used by all users. The default value is true.

{
    "type":"object",
    "properties":{
        "ChangeOrderTypeId":{
            "type":"integer",
            "description":"Unique identifier of the change order type used for the item class.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DefaultItemClassFlag":{
            "title":"Default Item Class",
            "maxLength":1,
            "type":"boolean",
            "description":"Default item classes for items created through import will be picked based on this option. Only one item class can have this option enabled.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item class.",
            "nullable":false,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the item class is enabled for use. If false, then the item class isn't enabled for use. The default value is true.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "InternalName":{
            "title":"Internal Name",
            "maxLength":80,
            "type":"string",
            "description":"Internal name of the item class.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemClass":{
            "title":"Item Class",
            "maxLength":80,
            "type":"string",
            "description":"Name of the item class.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemClassAttachmentCategories":{
            "title":"Attachment Categories",
            "type":"array",
            "description":"ItemClass.AttachmentCategories",
            "items":{
                "$ref":"#/components/schemas/itemClasses-ItemClassAttachmentCategories-item-response"
            }
        },
        "ItemClassCode":{
            "title":"Internal Name",
            "maxLength":80,
            "type":"string",
            "description":"Internal name of an item class.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemClassId":{
            "type":"integer",
            "description":"Unique identifier for an item class.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ItemClassPhases":{
            "title":"Lifecycle Phases",
            "type":"array",
            "description":"ItemClass.Phases",
            "items":{
                "$ref":"#/components/schemas/itemClasses-ItemClassPhases-item-response"
            }
        },
        "ItemClassType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of item class.",
            "nullable":true,
            "default":"Item",
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ItemCreationAllowedFlag":{
            "title":"Item Creation Allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then items can be created in this item class. If false, then items can't be created in this item class. The default value is true.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ItemDescriptionGenMethodCode":{
            "title":"Item Description Generation Method",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the item description generation method for the items of the item class.",
            "nullable":true,
            "default":"P",
            "x-queryable":true
        },
        "ItemDescriptionGenMethodValue":{
            "type":"string",
            "description":"Attribute used to specify the item description generation method for the items of the item class.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ItemNumberGenMethodCode":{
            "title":"Item Number Generation Method",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the item number generation method for the items of the item class",
            "nullable":true,
            "default":"P",
            "x-queryable":true
        },
        "ItemNumberGenMethodValue":{
            "type":"string",
            "description":"An attribute used to specify the item number generation method for items created in the item class.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "NewItemRequestRequiredFlag":{
            "title":"New Item Request Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then a new item request is required for items of the item class. If false, then a new item request isn't required for items of the item class.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ParentItemClass":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the parent item class.",
            "nullable":true,
            "x-queryable":true
        },
        "ParentItemClassDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the parent item class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentItemClassId":{
            "type":"integer",
            "description":"Parent item class of the child item class.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PublicFlag":{
            "title":"Public",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then this item class can be used by all users. If false, this item class can't be used by all users. The default value is true.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Attachment Categories

Type: array

Title: Attachment Categories

ItemClass.AttachmentCategories

Show Source

• Array of: object itemClasses-ItemClassAttachmentCategories-item-response

{
    "title":"Attachment Categories",
    "type":"array",
    "description":"ItemClass.AttachmentCategories",
    "items":{
        "$ref":"#/components/schemas/itemClasses-ItemClassAttachmentCategories-item-response"
    }
}

Nested Schema : Lifecycle Phases

Type: array

Title: Lifecycle Phases

ItemClass.Phases

Show Source

• Array of: object itemClasses-ItemClassPhases-item-response

{
    "title":"Lifecycle Phases",
    "type":"array",
    "description":"ItemClass.Phases",
    "items":{
        "$ref":"#/components/schemas/itemClasses-ItemClassPhases-item-response"
    }
}

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 : itemClasses-ItemClassAttachmentCategories-item-response

Type: object

Show Source

• AttachCategoryId: integer (int64)
  Title: Attachment Category

  Unique identifier of attachment category.
• AttachmentCategoryCode: string
  Code of the attachment category.
• AttachmentCategoryName: string
  Name of the attachment category.
• ClassificationId: string
  Title: Attachment Category

  Maximum Length: 150

  Internal name of an item class.
• CreationDate: string (date-time)
  Read Only: true

  Who column: Indicates the date and time of the record creation.
• CurrentItemClassId: string
  Read Only: true

  Maximum Length: 32

  Unique identifier of current item class.
• EndDate: string (date)
  Title: End Date

  End date of the association between the attachment category and item class.
• EntityName: string
  Entity name of the attachment category.
• Inherited: string
  Read Only: true

  Maximum Length: 1

  Flag indicating whether the record is inherited from one of the item class in its hierarchy
• ItemClassCode: string
  Read Only: true

  Maximum Length: 800

  Internal name for Item Class.
• LastUpdateDate: string (date-time)
  Read Only: true

  Who column: Indicates the date and time the record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjName: string
  Maximum Length: 80

  Default Value: EGO_CATALOG_GROUP

  Attachment internal attribute, always pass 'EGO_CATALOG_GROUP' as value.
• StartDate: string (date)
  Title: Start Date

  Start date of the association between the attachment category and item class.

{
    "type":"object",
    "properties":{
        "AttachCategoryId":{
            "title":"Attachment Category",
            "type":"integer",
            "description":"Unique identifier of attachment category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttachmentCategoryCode":{
            "type":"string",
            "description":"Code of the attachment category.",
            "nullable":true,
            "x-queryable":true
        },
        "AttachmentCategoryName":{
            "type":"string",
            "description":"Name of the attachment category.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClassificationId":{
            "title":"Attachment Category",
            "maxLength":150,
            "type":"string",
            "description":"Internal name of an item class.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Who column: Indicates the date and time of the record creation.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentItemClassId":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier of current item class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"End date of the association between the attachment category and item class.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EntityName":{
            "type":"string",
            "description":"Entity name of the attachment category.",
            "nullable":true,
            "x-queryable":true
        },
        "Inherited":{
            "maxLength":1,
            "type":"string",
            "description":"Flag indicating whether the record is inherited from one of the item class in its hierarchy",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemClassCode":{
            "maxLength":800,
            "type":"string",
            "description":"Internal name for Item Class.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Who column: Indicates the date and time the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjName":{
            "maxLength":80,
            "type":"string",
            "description":"Attachment internal attribute, always  pass 'EGO_CATALOG_GROUP' as value.",
            "nullable":false,
            "default":"EGO_CATALOG_GROUP",
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Start date of the association between the attachment category and item class.",
            "format":"date",
            "nullable":false,
            "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."
        }
    }
}

Nested Schema : itemClasses-ItemClassPhases-item-response

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  Read Only: true

  Date when the lifecycle phase ends.
• ItemClass: string
  Title: Item Class

  Read Only: true

  Maximum Length: 250

  Name of the item class.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PhaseCode: string
  Title: Lifecycle Phase

  Maximum Length: 30

  Value that identifies the lifecycle phase.
• PhaseName: string
  Title: Phase

  Maximum Length: 80

  Name of the lifecycle phase.
• PhaseSequence: integer (int32)
  Title: Sequence

  Read Only: true

  Sequence number of the lifecycle phase.
• PhaseType: string
  Title: Phase Type

  Read Only: true

  Maximum Length: 30

  Type of life cycle phase.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  Date when the lifecycle phase begins.

{
    "type":"object",
    "properties":{
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the lifecycle phase ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemClass":{
            "title":"Item Class",
            "maxLength":250,
            "type":"string",
            "description":"Name of the item class.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhaseCode":{
            "title":"Lifecycle Phase",
            "maxLength":30,
            "type":"string",
            "description":"Value that identifies the lifecycle phase.",
            "nullable":false,
            "x-queryable":true
        },
        "PhaseName":{
            "title":"Phase",
            "maxLength":80,
            "type":"string",
            "description":"Name of the lifecycle phase.",
            "nullable":false,
            "x-queryable":true
        },
        "PhaseSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"Sequence number of the lifecycle phase.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "PhaseType":{
            "title":"Phase Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of life cycle phase.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"EGO_LIFECYCLE_PHASES",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the lifecycle phase begins.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "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"
    }
}

Links

ItemClassAttachmentCategories

Operation: /fscmRestApi/resources/11.13.18.05/itemClasses/{ItemClassId}/child/ItemClassAttachmentCategories

Parameters:

• ItemClassId: $request.path.ItemClassId

ItemClass.AttachmentCategories

ItemClassPhases

Operation: /fscmRestApi/resources/11.13.18.05/itemClasses/{ItemClassId}/child/ItemClassPhases

Parameters:

• ItemClassId: $request.path.ItemClassId

ItemClass.Phases

Back to Top