Jump to

• Request
• Response

Get one output item

get

/fscmRestApi/resources/11.13.18.05/planInputs/{PlanInputId}/child/OutputItems/{OutputItemsUniqID}

Request

Path Parameters

• OutputItemsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Output Items resource and used to uniquely identify an instance of Output Items. The client should not generate the hash key value. Instead, the client should query on the Output Items collection resource in order to navigate to a specific instance of Output Items to get the hash key.
• PlanInputId(required): integer
  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 : planInputs-OutputItems-item-response

Type: object

Show Source

• AssemblyItem: string
  Title: Assembly Item

  Read Only: true

  Maximum Length: 300

  Name of the assembly item.
• AssemblyItemId: integer
  Read Only: true

  Unique identifier of the assembly item.
• BatchQuantity: number
  Title: Batch Quantity

  Read Only: true

  Quantity of the production batch used for batch sizing and scaling.
• BatchQuantityUOM: string
  Title: Batch Quantity UOM

  Read Only: true

  Maximum Length: 4000

  Unit of measure of the output item batch quantity.
• BatchQuantityUOMCode: string
  Read Only: true

  Maximum Length: 3

  Unit of measure code of the output item batch quantity.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the output item.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the output item.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the output item was most recently updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the output item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationSequenceId: integer
  Read Only: true

  Unique identifier of the operation sequence.
• OperationSequenceNumber: integer
  Title: Operation Sequence Number

  Read Only: true

  Number that identifies the execution sequence of the operation.
• Organization: string
  Title: Organization

  Read Only: true

  Maximum Length: 255

  Organization name of the output item.
• OrganizationCode: string
  Title: Organization

  Read Only: true

  Maximum Length: 4000

  Organization code of the output item.
• OrganizationId: integer (int64)
  Read Only: true

  Unique identifier of the organization.
• OutputItem: string
  Title: Output Item

  Read Only: true

  Maximum Length: 300

  Item produced at various operations of a process work definition.
• OutputItemId: integer (int64)
  Read Only: true

  Unique identifier of the output item.
• OutputQuantity: number
  Title: Output Quantity

  Read Only: true

  Quantity of the output item.
• OutputQuantityUOM: string
  Title: Output Item UOM

  Read Only: true

  Maximum Length: 4000

  Unit of measure of the output item quantity.
• OutputQuantityUOMCode: string
  Read Only: true

  Maximum Length: 3

  Unit of measure code of the output item quantity.
• OutputTypeCode: integer (int64)
  Title: Output Type

  Read Only: true

  Code of the type of output produced by an operation in a process work definition. Output type can be primary product, co-product, or by-product.
• OutputTypeName: string
  Title: Output Type

  Read Only: true

  Maximum Length: 255

  Type of output produced by an operation in a process work definition. Output type can be primary product, co-product, or by-product.
• PlanId: integer (int64)
  Read Only: true

  Value that uniquely identifies the plan.
• WorkDefinitionName: string
  Title: Work Definition

  Read Only: true

  Maximum Length: 300

  Name of the work definition associated with the output item.

{
    "type":"object",
    "properties":{
        "OutputItemId":{
            "type":"integer",
            "description":"Unique identifier of the output item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the output item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the output item.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Organization":{
            "title":"Organization",
            "maxLength":255,
            "type":"string",
            "description":"Organization name of the output item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the output item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OutputQuantityUOM":{
            "title":"Output Item UOM",
            "maxLength":4000,
            "type":"string",
            "description":"Unit of measure of the output item quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchQuantityUOM":{
            "title":"Batch Quantity UOM",
            "maxLength":4000,
            "type":"string",
            "description":"Unit of measure of the output item batch quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionName":{
            "title":"Work Definition",
            "maxLength":300,
            "type":"string",
            "description":"Name of the work definition associated with the output item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OutputItem":{
            "title":"Output Item",
            "maxLength":300,
            "type":"string",
            "description":"Item produced at various operations of a process work definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Unique identifier of the organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OutputQuantityUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure code of the output item quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchQuantity":{
            "title":"Batch Quantity",
            "type":"number",
            "description":"Quantity of the production batch used for batch sizing and scaling.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceId":{
            "type":"integer",
            "description":"Unique identifier of the operation sequence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BatchQuantityUOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Unit of measure code of the output item batch quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssemblyItemId":{
            "type":"integer",
            "description":"Unique identifier of the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssemblyItem":{
            "title":"Assembly Item",
            "maxLength":300,
            "type":"string",
            "description":"Name of the assembly item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence Number",
            "type":"integer",
            "description":"Number that identifies the execution sequence of the operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization",
            "maxLength":4000,
            "type":"string",
            "description":"Organization code of the output item.",
            "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"
            }
        },
        "OutputQuantity":{
            "title":"Output Quantity",
            "type":"number",
            "description":"Quantity of the output item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputTypeName":{
            "title":"Output Type",
            "maxLength":255,
            "type":"string",
            "description":"Type of output produced by an operation in a process work definition. Output type can be primary product, co-product, or by-product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutputTypeCode":{
            "title":"Output Type",
            "type":"integer",
            "description":"Code of the type of output produced by an operation in a process work definition. Output type can be primary product, co-product, or by-product.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":120
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the output item was most recently updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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