Jump to

• Request
• Response

Create one ATO material

post

/fscmRestApi/resources/11.13.18.05/workDefinitionRequests/{workDefinitionRequestsUniqID}/child/workDefinitionHeaders/{workDefinitionHeadersUniqID}/child/ATOMaterials

Request

Path Parameters

• workDefinitionHeadersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Definition Headers resource and used to uniquely identify an instance of Work Definition Headers. The client should not generate the hash key value. Instead, the client should query on the Work Definition Headers collection resource in order to navigate to a specific instance of Work Definition Headers to get the hash key.
• workDefinitionRequestsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Work Definition Requests resource and used to uniquely identify an instance of Work Definition Requests. The client should not generate the hash key value. Instead, the client should query on the Work Definition Requests collection resource in order to navigate to a specific instance of Work Definition Requests to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Value that specifies the desired action to perform on the alternate resource of a work definition assemble-to-order (ATO) materials. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute.
• ComponentHierarchy: string
  Maximum Length: 4000

  Value that indicates the hierarchy in the item structure at which the material is assigned.
• ErrorMessageNames: string
  Maximum Length: 255

  Names of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
• ErrorMessages: string
  Maximum Length: 2000

  Text of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• FindNumber: number
  Unique identifier of a component that appears more than once in an item structure.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• MaterialSequenceNumber: number
  Number that indicates the unique sequence of the component assigned to the work definition operation.
• OperationSequenceNumber: number
  Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
• StartDate: string (date-time)
  Date when the material assignment begins.
• SupplyLocator: string
  Maximum Length: 255

  Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
• SupplySubinventory: string
  Maximum Length: 10

  Value that indicates the subinventory from which this material is consumed.
• SupplyType: string
  Maximum Length: 30

  Value that indicates the supply type. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). If a value is not specified in the request payload, then the default value in the item structure for item structure components is used. for ad hoc items, the default value in the item master is used.

{
    "type":"object",
    "properties":{
        "SupplySubinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Value that indicates the subinventory from which this material is consumed.",
            "nullable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the desired action to perform on the alternate resource of a work definition assemble-to-order (ATO) materials. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute.",
            "nullable":false
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Names of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.",
            "nullable":true
        },
        "SupplyLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.",
            "nullable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the material assignment begins.",
            "format":"date-time",
            "nullable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true
        },
        "ComponentHierarchy":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the hierarchy in the item structure at which the material is assigned.",
            "nullable":true
        },
        "FindNumber":{
            "type":"number",
            "description":"Unique identifier of a component that appears more than once in an item structure.",
            "nullable":true
        },
        "MaterialSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the unique sequence of the component assigned to the work definition operation.",
            "nullable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.",
            "nullable":true
        },
        "SupplyType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the supply type. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). \nIf a value is not specified in the request payload, then the default value in the item structure for item structure components is used. for ad hoc items, the default value in the item master is used.",
            "nullable":true
        }
    }
}

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 : workDefinitionRequests-workDefinitionHeaders-ATOMaterials-item-response

Type: object

Show Source

• ActionCode: string
  Maximum Length: 30

  Value that specifies the desired action to perform on the alternate resource of a work definition assemble-to-order (ATO) materials. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute.
• ComponentHierarchy: string
  Maximum Length: 4000

  Value that indicates the hierarchy in the item structure at which the material is assigned.
• ErrorMessageNames: string
  Maximum Length: 255

  Names of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.
• ErrorMessages: string
  Maximum Length: 2000

  Text of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.
• FindNumber: number
  Unique identifier of a component that appears more than once in an item structure.
• ItemNumber: string
  Maximum Length: 300

  Number that identifies the item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaterialSequenceNumber: number
  Number that indicates the unique sequence of the component assigned to the work definition operation.
• OperationSequenceNumber: number
  Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.
• StartDate: string (date-time)
  Date when the material assignment begins.
• SupplyLocator: string
  Maximum Length: 255

  Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.
• SupplySubinventory: string
  Maximum Length: 10

  Value that indicates the subinventory from which this material is consumed.
• SupplyType: string
  Maximum Length: 30

  Value that indicates the supply type. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). If a value is not specified in the request payload, then the default value in the item structure for item structure components is used. for ad hoc items, the default value in the item master is used.

{
    "type":"object",
    "properties":{
        "SupplySubinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Value that indicates the subinventory from which this material is consumed.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the desired action to perform on the alternate resource of a work definition assemble-to-order (ATO) materials. Valid values are CREATE, UPDATE, or DELETE. This is a mandatory attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":"255",
            "type":"string",
            "description":"Names of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A comma (,) separates each message name.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyLocator":{
            "maxLength":"255",
            "type":"string",
            "description":"Locator in subinventory to use, by default, when the plant uses material during assembly or an operation pull.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":"2000",
            "type":"string",
            "description":"Text of the error messages that occurred when processing the work definition assemble-to-order (ATO) material. Each text string in the ErrorMessages attribute corresponds to one error message name in the ErrorMessageNames attribute. A double dollar sign ($$) separates each message.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the material assignment begins.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ItemNumber":{
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ComponentHierarchy":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the hierarchy in the item structure at which the material is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "FindNumber":{
            "type":"number",
            "description":"Unique identifier of a component that appears more than once in an item structure.",
            "nullable":true,
            "x-queryable":true
        },
        "MaterialSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the unique sequence of the component assigned to the work definition operation.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the execution sequence of the operation. A valid value must be a positive whole number.",
            "nullable":true,
            "x-queryable":true
        },
        "SupplyType":{
            "maxLength":"30",
            "type":"string",
            "description":"Value that indicates the supply type. Valid values are 1 (Push), 2 (Assembly Pull), 3 (Operation Pull), 4 (Bulk), 5 (Supplier), and 6 (Phantom). \nIf a value is not specified in the request payload, then the default value in the item structure for item structure components is used. for ad hoc items, the default value in the item master is used.",
            "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 : 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