Jump to

• Request
• Response

Get one demand

get

/fscmRestApi/resources/11.13.18.05/productionSchedulingPlans/{PlanId}/child/demandEvents/{demandEventsUniqID}

Request

Path Parameters

• PlanId(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=
• demandEventsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId and DemandId ---for the Demand Events resource and used to uniquely identify an instance of Demand Events. The client should not generate the hash key value. Instead, the client should query on the Demand Events collection resource with a filter on the primary key values in order to navigate to a specific instance of Demand Events.
  
  For example: demandEvents?q=PlanId=<value1>;DemandId=<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:
  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 : productionSchedulingPlans-demandEvents-item-response

Type: object

Show Source

• AvailableDate: string (date-time)
  Date when the demand line-item engine is scheduled.
• CustomerName: string
  Maximum Length: 300

  Name of the customer with the demand.
• CustomerNumber: string
  Maximum Length: 240

  Number of the customer with the demand.
• DemandHeaderId: integer (int64)
  Value that uniquely identifies the demand header.
• DemandId: integer (int64)
  Value the uniquely identifies the demand.
• DemandLineItemNumber: string
  Maximum Length: 150

  Number that identifies the line of the demand.
• DemandNumber: string
  Maximum Length: 240

  Number that identifies the demand.
• DemandPriority: number
  Priority of the demand.
• DemandStatus: string
  Maximum Length: 30

  User defined status of the line-item. Valid values include Approved or OnHold.
• DemandType: string
  Maximum Length: 30

  Type of demand order. Valid values include Order, Forecast, and Safety.
• EarliestDate: string (date-time)
  Date when the user created the earliest demand.
• FolderPath: string
  Maximum Length: 300

  Path where the demand is located.
• InventoryItemId: integer (int64)
  Value that uniquely identifies the inventory item.
• ItemCode: string
  Read Only: true

  Maximum Length: 300

  Abbreviation that identifies the item.
• ItemDescription: string
  Read Only: true

  Maximum Length: 500

  Description of the item of the demand.
• LatestDate: string (date-time)
  Date when the user created the most recent demand.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrderClass: string
  Maximum Length: 20

  Order class of the demand. Valid values include HotOrder, Committed, and Uncommitted.
• PlanId: integer (int64)
  Value that uniquely identifies the production schedule.
• Precision: integer (int64)
  Read Only: true

  Display precision of the demand line item.
• Quantity: number
  Quantity for the demand line-item.
• RequestDate: string (date-time)
  Date when the demand is requested.
• ReservationsFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then the demand order has reservations for this line-item. If N, then the demand order doesn't have reservations for this line-item. This attribute doesn't have a default value.
• SatisfactionDate: string (date-time)
  Date when the demand line-item is satisfied.
• ShipCompleteFlag: boolean
  Maximum Length: 1

  Contains one of the following values: Y or N. If Y, then shipping is complete on the demand order. If N, then shipping isn't complete on the demand order. This attribute doesn't have a default value.
• ShipToAddress: string
  Maximum Length: 240

  Address to ship to of the demand order which can contain multiple lines.
• TargetCompletionDate: string (date-time)
  Date when the demand line-item completion is targeted.
• TransferOrderHeaderId: integer (int64)
  Value that uniquely identifies the transfer order.
• UnitOfMeasure: string
  Read Only: true

  Maximum Length: 25

  Name of the unit of measure.
• UOMCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the unit of measure.

{
    "type":"object",
    "properties":{
        "ReservationsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then the demand order has reservations for this line-item. If N, then the demand order doesn't have reservations for this line-item. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToAddress":{
            "maxLength":240,
            "type":"string",
            "description":"Address to ship to of the demand order which can contain multiple lines.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemCode":{
            "maxLength":300,
            "type":"string",
            "description":"Abbreviation that identifies the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the demand header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandId":{
            "type":"integer",
            "description":"Value the uniquely identifies the demand.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SatisfactionDate":{
            "type":"string",
            "description":"Date when the demand line-item is satisfied.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "AvailableDate":{
            "type":"string",
            "description":"Date when the demand line-item engine is scheduled.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ShipCompleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: Y or N. If Y, then shipping is complete on the demand order. If N, then shipping isn't complete on the demand order. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "EarliestDate":{
            "type":"string",
            "description":"Date when the user created the earliest demand.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ItemDescription":{
            "maxLength":500,
            "type":"string",
            "description":"Description of the item of the demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestDate":{
            "type":"string",
            "description":"Date when the demand is requested.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Number of the customer with the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the customer with the demand.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandLineItemNumber":{
            "maxLength":150,
            "type":"string",
            "description":"Number that identifies the line of the demand.",
            "nullable":false,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferOrderHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the transfer order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Number that identifies the demand.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "maxLength":25,
            "type":"string",
            "description":"Name of the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the production schedule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FolderPath":{
            "maxLength":300,
            "type":"string",
            "description":"Path where the demand is located.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Quantity":{
            "type":"number",
            "description":"Quantity for the demand line-item.",
            "nullable":false,
            "x-queryable":true
        },
        "LatestDate":{
            "type":"string",
            "description":"Date when the user created the most recent demand.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OrderClass":{
            "maxLength":20,
            "type":"string",
            "description":"Order class of the demand. Valid values include HotOrder, Committed, and Uncommitted.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetCompletionDate":{
            "type":"string",
            "description":"Date when the demand line-item completion is targeted.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Precision":{
            "type":"integer",
            "description":"Display precision of the demand line item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "DemandType":{
            "maxLength":30,
            "type":"string",
            "description":"Type of demand order. Valid values include Order, Forecast, and Safety.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandPriority":{
            "type":"number",
            "description":"Priority of the demand.",
            "nullable":false,
            "x-queryable":true
        },
        "DemandStatus":{
            "maxLength":30,
            "type":"string",
            "description":"User defined status of the line-item. Valid values include Approved or OnHold.",
            "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