Jump to

• Request
• Response

Get one reservation

get

/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderReservation/{ReservationId}

Request

Path Parameters

• ReservationId(required): integer
  Value that uniquely identifies the reservation of the work order quantity for the demand. It's a primary key that the application generates when it creates the reservation.
• processWorkOrdersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Process Work Orders resource and used to uniquely identify an instance of Process Work Orders. The client should not generate the hash key value. Instead, the client should query on the Process Work Orders collection resource in order to navigate to a specific instance of Process Work Orders to get the hash key.

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 : processWorkOrders-ProcessWorkOrderReservation-item-response

Type: object

Show Source

• CustomerName: string
  Title: Customer

  Read Only: true

  Maximum Length: 360

  Name of the customer on the demand source document.
• CustomerNumber: string
  Title: Customer Number

  Read Only: true

  Maximum Length: 30

  Number that uniquely identifies the customer on the sales order that the work order's reserved for fulfillment.
• DemandQuantity: number
  Title: Demand Line Quantity

  Read Only: true

  Quantity of the work order that's reserved to fulfill a demand.
• DemandSourceHeaderNumber: string
  Title: Demand Document Number

  Read Only: true

  Maximum Length: 4000

  Header number of the demand document that references the work order.
• DemandSourceLineNumber: string
  Title: Demand Document Line Number

  Read Only: true

  Maximum Length: 1201

  Line number of the demand document that references the work order.
• DemandSourceTypeName: string
  Title: Demand Document Type

  Read Only: true

  Maximum Length: 80

  Name of the source where the demand originated.
• DemandUnitOfMeasure: string
  Title: Demand Line Quantity UOM

  Read Only: true

  Maximum Length: 3

  Primary unit of measure for the work order quantity that's reserved to fulfill a demand.
• DueDate: string (date)
  Title: Due Date

  Read Only: true

  Date when the demand item is due.
• InventoryItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the item, product, or assembly in the inventory organization.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.
• ReservationId: integer
  Read Only: true

  Value that uniquely identifies the reservation of the work order quantity for the demand. It's a primary key that the application generates when it creates the reservation.
• ReservationQuantity: number
  Title: Work Order Reserved Quantity

  Read Only: true

  Quantity of the work order that the application reserves for each demand item.
• ReservationUnitOfMeasure: string
  Title: Reserved Quantity UOM

  Read Only: true

  Maximum Length: 25

  Primary unit of measure that the quantity reserved uses.
• SupplySourceHeaderId: integer (int64)
  Read Only: true

  Value that uniquely identifies the document header in the demand source.

{
    "type":"object",
    "properties":{
        "DemandSourceHeaderNumber":{
            "title":"Demand Document Number",
            "maxLength":4000,
            "type":"string",
            "description":"Header number of the demand document that references the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandUnitOfMeasure":{
            "title":"Demand Line Quantity UOM",
            "maxLength":3,
            "type":"string",
            "description":"Primary unit of measure for the work order quantity that's reserved to fulfill a demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandQuantity":{
            "title":"Demand Line Quantity",
            "type":"number",
            "description":"Quantity of the work order that's reserved to fulfill a demand.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item, product, or assembly in the inventory organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DemandSourceLineNumber":{
            "title":"Demand Document Line Number",
            "maxLength":1201,
            "type":"string",
            "description":"Line number of the demand document that references the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DemandSourceTypeName":{
            "title":"Demand Document Type",
            "maxLength":80,
            "type":"string",
            "description":"Name of the source where the demand originated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplySourceHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document header in the demand source.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReservationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the reservation of the work order quantity for the demand. It's a primary key that the application generates when it creates the reservation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerNumber":{
            "title":"Customer Number",
            "maxLength":30,
            "type":"string",
            "description":"Number that uniquely identifies the customer on the sales order that the work order's reserved for fulfillment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReservationQuantity":{
            "title":"Work Order Reserved Quantity",
            "type":"number",
            "description":"Quantity of the work order that the application reserves for each demand item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReservationUnitOfMeasure":{
            "title":"Reserved Quantity UOM",
            "maxLength":25,
            "type":"string",
            "description":"Primary unit of measure that the quantity reserved uses.",
            "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"
            }
        },
        "CustomerName":{
            "title":"Customer",
            "maxLength":360,
            "type":"string",
            "description":"Name of the customer on the demand source document.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DueDate":{
            "title":"Due Date",
            "type":"string",
            "description":"Date when the demand item is due.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "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