Jump to

• Request
• Response

Get all pull sequence details

get

/fscmRestApi/resources/11.13.18.05/kanbanPullSequenceDetails

Request

Query Parameters

• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds pull sequence details.
    Finder Variables:
    • PullSequenceId; integer; Value that uniquely identifies the pull sequence details.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • InventoryItemId; integer; Unique identifier of the item defined in the pull sequence.
  • ItemDescription; string; Description of the item in the pull sequence.
  • ItemNumber; string; Item number in the pull sequence.
  • LastUpdateDate; string; Date and time of the last update of the row.
  • Locator; string; Name of the locator from where the item is sourced.
  • LocatorId; integer; Identifier of the destination locator of the item in the pull sequence.
  • NumberOfCards; integer; Indicates the number of Kanban cards for the pull sequence.
  • OrganizationId; integer; Organization identifier of the inventory organization to which this pull sequence belongs.
  • ProductionLineId; integer; Unique identifier of the production line from which the item is sourced.
  • ProductionLineName; string; Name of the production line from which the item is sourced.
  • PullSequenceId; integer; Unique identifier of the Kanban pull sequence. Its value is an application-generated unique ID.
  • SourceLocator; string; Name of the locator from where the item is sourced according to the specified source type value.
  • SourceLocatorId; integer; Identifier of the locator from which the item is sourced.
  • SourceOrganizationCode; string; Code of the inventory organization from where the item is sourced.
  • SourceOrganizationId; integer; Unique identifier of the inventory organization from which the item is sourced.
  • SourceOrganizationName; string; Name of the inventory organization from where the item is sourced.
  • SourceSubinventoryCode; string; Name of the subinventory from which the item is sourced.
  • SourceType; string; Type of supply used for sourcing the item in the pull sequence.
  • SourceTypeDescription; string; Description of the type of supply used to source the item in the pull sequence.
  • SubinventoryCode; string; Name of the destination subinventory of the item in the pull sequence.
  • SupplierId; integer; Identifier of the supplier from which the item is sourced.
  • SupplierName; string; Name of the supplier from which the item is sourced
  • SupplierSiteCode; string; Code of the supplier site from where the item is sourced.
  • SupplierSiteId; integer; Identifier of the supplier site from which the item is sourced.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 : kanbanPullSequenceDetails

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/kanbanPullSequenceDetails-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Manufacturing",
        "usage":"BusinessObject",
        "isCompactViewByDefault":true,
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object kanbanPullSequenceDetails-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/kanbanPullSequenceDetails-item-response"
    }
}

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 : kanbanPullSequenceDetails-item-response

Type: object

Show Source

• InventoryItemId: integer (int64)
  Title: Item

  Read Only: true

  Unique identifier of the item defined in the pull sequence.
• ItemDescription: string
  Title: Item Description

  Read Only: true

  Maximum Length: 240

  Description of the item in the pull sequence.
• ItemNumber: string
  Title: Item

  Read Only: true

  Maximum Length: 300

  Item number in the pull sequence.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time of the last update of the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Locator: string
  Title: Destination Locator

  Read Only: true

  Maximum Length: 255

  Name of the locator from where the item is sourced.
• LocatorId: integer (int64)
  Title: Destination Locator

  Read Only: true

  Identifier of the destination locator of the item in the pull sequence.
• NumberOfCards: integer
  Title: Number of Cards

  Indicates the number of Kanban cards for the pull sequence.
• OrganizationId: integer (int64)
  Title: Organization

  Read Only: true

  Organization identifier of the inventory organization to which this pull sequence belongs.
• ProductionLineId: integer (int64)
  Read Only: true

  Unique identifier of the production line from which the item is sourced.
• ProductionLineName: string
  Read Only: true

  Maximum Length: 120

  Name of the production line from which the item is sourced.
• PullSequenceId: integer (int64)
  Read Only: true

  Unique identifier of the Kanban pull sequence. Its value is an application-generated unique ID.
• SourceLocator: string
  Title: Source Locator

  Read Only: true

  Maximum Length: 255

  Name of the locator from where the item is sourced according to the specified source type value.
• SourceLocatorId: integer (int64)
  Title: Source Locator

  Read Only: true

  Identifier of the locator from which the item is sourced.
• SourceOrganizationCode: string
  Title: Source Organization Code

  Read Only: true

  Maximum Length: 18

  Code of the inventory organization from where the item is sourced.
• SourceOrganizationId: integer (int64)
  Title: Source Organization

  Unique identifier of the inventory organization from which the item is sourced.
• SourceOrganizationName: string
  Title: Source Organization Name

  Read Only: true

  Maximum Length: 240

  Name of the inventory organization from where the item is sourced.
• SourceSubinventoryCode: string
  Title: Source Subinventory

  Read Only: true

  Maximum Length: 10

  Name of the subinventory from which the item is sourced.
• SourceType: string
  Title: Source Type

  Read Only: true

  Maximum Length: 30

  Type of supply used for sourcing the item in the pull sequence.
• SourceTypeDescription: string
  Title: Source Type

  Read Only: true

  Maximum Length: 255

  Description of the type of supply used to source the item in the pull sequence.
• SubinventoryCode: string
  Title: Destination Subinventory

  Read Only: true

  Maximum Length: 10

  Name of the destination subinventory of the item in the pull sequence.
• SupplierId: integer (int64)
  Title: Supplier

  Read Only: true

  Identifier of the supplier from which the item is sourced.
• SupplierName: string
  Title: Supplier

  Read Only: true

  Maximum Length: 255

  Name of the supplier from which the item is sourced
• SupplierSiteCode: string
  Title: Supplier Site

  Read Only: true

  Maximum Length: 255

  Code of the supplier site from where the item is sourced.
• SupplierSiteId: integer (int64)
  Title: Supplier Site

  Read Only: true

  Identifier of the supplier site from which the item is sourced.

{
    "type":"object",
    "properties":{
        "SourceType":{
            "title":"Source Type",
            "maxLength":30,
            "type":"string",
            "description":"Type of supply used for sourcing the item in the pull sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceOrganizationName":{
            "title":"Source Organization Name",
            "maxLength":240,
            "type":"string",
            "description":"Name of the inventory organization from where the item is sourced.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"Organization identifier of the inventory organization to which this pull sequence belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "SubinventoryCode":{
            "title":"Destination Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Name of the destination subinventory of the item in the pull sequence.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the item in the pull sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteCode":{
            "title":"Supplier Site",
            "maxLength":255,
            "type":"string",
            "description":"Code of the supplier site from where the item is sourced.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SupplierSiteId"
                ]
            },
            "x-queryable":true
        },
        "Locator":{
            "title":"Destination Locator",
            "maxLength":255,
            "type":"string",
            "description":"Name of the locator from where the item is sourced.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LocatorId",
                    "OrganizationId"
                ]
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item",
            "maxLength":300,
            "type":"string",
            "description":"Item number in the pull sequence.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteId":{
            "title":"Supplier Site",
            "type":"integer",
            "description":"Identifier of the supplier site from which the item is sourced.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTypeDescription":{
            "title":"Source Type",
            "maxLength":255,
            "type":"string",
            "description":"Description of the type of supply used to source the item in the pull sequence.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceType"
                ]
            },
            "x-queryable":true
        },
        "SourceLocatorId":{
            "title":"Source Locator",
            "type":"integer",
            "description":"Identifier of the locator from which the item is sourced.",
            "format":"int64",
            "nullable":true,
            "readOnly":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"
            }
        },
        "PullSequenceId":{
            "type":"integer",
            "description":"Unique identifier of the Kanban pull sequence. Its value is an application-generated unique ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "title":"Source Organization",
            "type":"integer",
            "description":"Unique identifier of the inventory organization from which the item is sourced.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "SourceType"
                ]
            },
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Unique identifier of the item defined in the pull sequence.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "LocatorId":{
            "title":"Destination Locator",
            "type":"integer",
            "description":"Identifier of the destination locator of the item in the pull sequence.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "ProductionLineName":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the production line from which the item is sourced.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier",
            "type":"integer",
            "description":"Identifier of the supplier from which the item is sourced.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductionLineId":{
            "type":"integer",
            "description":"Unique identifier of the production line from which the item is sourced.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier",
            "maxLength":255,
            "type":"string",
            "description":"Name of the supplier from which the item is sourced",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SupplierId"
                ]
            },
            "x-queryable":true
        },
        "SourceLocator":{
            "title":"Source Locator",
            "maxLength":255,
            "type":"string",
            "description":"Name of the locator from where the item is sourced according to the specified source type value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "OrganizationId",
                    "SourceLocatorId"
                ]
            },
            "x-queryable":true
        },
        "SourceOrganizationCode":{
            "title":"Source Organization Code",
            "maxLength":18,
            "type":"string",
            "description":"Code of the inventory organization from where the item is sourced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NumberOfCards":{
            "title":"Number of Cards",
            "type":"integer",
            "description":"Indicates the number of Kanban cards for the pull sequence.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceSubinventoryCode":{
            "title":"Source Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Name of the subinventory from which the item is sourced.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":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