Jump to

• Request
• Response

Get all item classes

get

/fscmRestApi/resources/11.13.18.05/itemClasses

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • ItemClassAltKey Find item classes according to the specified criteria.
    Finder Variables
    • ItemClassCode; string; Value that identifies the item class.
  • ItemClassNameAltKey Find item classes according to the specified criteria.
    Finder Variables
    • ItemClassName; string; Name of the item class.
  • PrimaryKey Find item classes according to the primary key criteria.
    Finder Variables
    • ItemClassId; integer; Name of the item class.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Description; string; Description of the item class.
  • EnabledFlag; boolean; 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; Internal name of the item class.
  • ItemClass; string; Name of the item class.
  • ItemCreationAllowedFlag; boolean; 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.
  • ParentItemClass; string; Name of the parent item class.
  • ParentItemClassDescription; string; Description of the parent item class.
  • PublicFlag; boolean; 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.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

Response

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.

Body ()

Root Schema : itemClasses

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/itemClasses-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"ProductLifecycleManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object itemClasses-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/itemClasses-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-item-response

Type: object

Show Source

• 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.
• ItemClassPhases: array Lifecycle Phases
  Title: Lifecycle Phases

  ItemClass.Phases
• 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.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• 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.
• 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":{
        "ItemClass":{
            "title":"Item Class",
            "maxLength":80,
            "type":"string",
            "description":"Name of the item class.",
            "nullable":false,
            "x-queryable":true
        },
        "ParentItemClass":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the parent item class.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item class.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemClassPhases":{
            "title":"Lifecycle Phases",
            "type":"array",
            "description":"ItemClass.Phases",
            "items":{
                "$ref":"#/components/schemas/itemClasses-ItemClassPhases-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParentItemClassDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the parent item class.",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "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
        },
        "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
        }
    }
}

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-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":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the lifecycle phase begins.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "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
        },
        "ItemClass":{
            "title":"Item Class",
            "maxLength":250,
            "type":"string",
            "description":"Name of the item class.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PhaseName":{
            "title":"Phase",
            "maxLength":80,
            "type":"string",
            "description":"Name of the lifecycle phase.",
            "nullable":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the lifecycle phase ends.",
            "format":"date",
            "nullable":true,
            "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
        }
    }
}

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