Jump to

• Request
• Response

Get one ABC Classification Set Item

get

/fscmRestApi/resources/11.13.18.05/abcClassifications/{CompileId}/child/abcClassificationSetItems/{abcClassificationSetItemsUniqID}

Request

Path Parameters

• CompileId(required): integer(int64)
  Value that uniquely identifies ABC Classification.
• abcClassificationSetItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- CompileId and InventoryItemId ---for the ABC Classification Set Items resource and used to uniquely identify an instance of ABC Classification Set Items. The client should not generate the hash key value. Instead, the client should query on the ABC Classification Set Items collection resource with a filter on the primary key values in order to navigate to a specific instance of ABC Classification Set Items.
  
  For example: abcClassificationSetItems?q=CompileId=<value1>;InventoryItemId=<value2>

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 : abcClassifications-abcClassificationSetItems-item-response

Type: object

Show Source

• CompileId: integer (int64)
  Indicates the ABC Classification associated with ABC Classification Set Item.
• CompileQuantity: number
  Title: ABC Classification Set Quantity

  Indicates the quantity of the ABC Classification Set Item.
• CompileValue: number
  Title: ABC Classification Set Value

  Indicates the value of the ABC classification set items.
• CreationDate: string (date-time)
  Read Only: true

  Indicates the date and time of the creation of the ABC Classification set item.
• CumulativeQuantity: number
  Title: Cumulative Quantity

  Indicates the cumulative quantity of all items with the sequence less than or equal to the ABC Classification set item.
• CumulativeValue: number
  Title: Cumulative Value

  Indicates the cumulative value of all items with the sequence less than or equal to the ABC Classification set item.
• InventoryItemId: integer (int64)
  Value that uniquely Identifies the inventory item of the ABC Classification set item.
• ItemDescription: string
  Maximum Length: 255

  Description of the item.
• ItemNumber: string
  Maximum Length: 255

  Indicates the item of the ABC Classification set item.
• ItemUnitCost: number
  Default Value: 0

  Indicates the unit cost of the item in the ABC Classification set item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Maximum Length: 255

  Indicates the code of the inventory organization.
• OrganizationId: integer (int64)
  Value that identifies the inventory organization.
• PrimaryUOMCode: string
  Maximum Length: 3

  Primary unit of measure code of the item.
• PrimaryUOMName: string
  Maximum Length: 255

  Primary unit of measure name of the item.
• SequenceNumber: integer (int64)
  Title: Sequence

  Indicates the sequence number of the items in the ABC Classification set item.

{
    "type":"object",
    "properties":{
        "CompileId":{
            "type":"integer",
            "description":"Indicates the ABC Classification associated with ABC Classification Set Item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CompileQuantity":{
            "title":"ABC Classification Set Quantity",
            "type":"number",
            "description":"Indicates the quantity of the ABC Classification Set Item.",
            "nullable":true,
            "x-queryable":true
        },
        "CompileValue":{
            "title":"ABC Classification Set Value",
            "type":"number",
            "description":"Indicates the value of the ABC classification set items.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time of the creation of the ABC Classification set item.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CumulativeQuantity":{
            "title":"Cumulative Quantity",
            "type":"number",
            "description":"Indicates the cumulative quantity of all items with the sequence less than or equal to the ABC Classification set item.",
            "nullable":true,
            "x-queryable":true
        },
        "CumulativeValue":{
            "title":"Cumulative Value",
            "type":"number",
            "description":"Indicates the cumulative value of all items with the sequence less than or equal to the ABC Classification set item.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely Identifies the inventory item of the ABC Classification set item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":255,
            "type":"string",
            "description":"Description of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the item of the ABC Classification set item.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemUnitCost":{
            "type":"number",
            "description":"Indicates the unit cost of the item in the ABC Classification set item.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Indicates the code of the inventory organization.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that identifies the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Primary unit of measure code of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryUOMName":{
            "maxLength":255,
            "type":"string",
            "description":"Primary unit of measure name of the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "title":"Sequence",
            "type":"integer",
            "description":"Indicates the sequence number of the items in the ABC Classification set item.",
            "format":"int64",
            "nullable":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