Get all release sequence rules

get

/fscmRestApi/resources/11.13.18.05/releaseSequenceRules

Request

Query Parameters
  • 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).
  • 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
  • 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 the release sequence rule with the specified primary key.
      Finder Variables
      • PickSequenceRuleId; integer; Unique identifier of the release sequence rule.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • CreatedBy; string; User who created the release sequence rule.
    • CreationDate; string; Date when the user created the release sequence rule.
    • Description; string; Description of the release sequence rule.
    • EndDateActive; string; Date when the release sequence rule becomes inactive.
    • LastUpdateDate; string; Date when the user most recently updated the release sequence rule.
    • LastUpdatedBy; string; User who most recently updated the release sequence rule.
    • PickSequenceRuleId; integer; Value that uniquely identifies the release sequence rule.
    • PickSequenceRuleName; string; Name of the release sequence rule.
    • Priority1Output; string; Indicates the shipment line attribute name and sorting option that's used as the first priority in sequencing the shipment lines.
    • Priority2Output; string; Indicates the shipment line attribute name and sorting option that's used as the second priority in sequencing the shipment lines.
    • Priority3Output; string; Indicates the shipment line attribute name and sorting option that's used as the third priority in sequencing the shipment lines.
    • Priority4Output; string; Indicates the shipment line attribute name and sorting option that's used as the fourth priority in sequencing the shipment lines.
    • Priority5Output; string; Indicates the shipment line attribute name and sorting option that's used as the fifth priority in sequencing the shipment lines.
    • StartDateActive; string; Date when the release sequence rule becomes active.
  • 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
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : releaseSequenceRules
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : releaseSequenceRules-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 64
    User who created the release sequence rule.
  • Read Only: true
    Date when the user created the release sequence rule.
  • Title: Description
    Maximum Length: 240
    Description of the release sequence rule.
  • Title: End Date
    Date when the release sequence rule becomes inactive.
  • Read Only: true
    Date when the user most recently updated the release sequence rule.
  • Read Only: true
    Maximum Length: 64
    User who most recently updated the release sequence rule.
  • Links
  • Value that uniquely identifies the release sequence rule.
  • Title: Name
    Maximum Length: 60
    Name of the release sequence rule.
  • Title: Priority 1
    Abbreviation of the shipment line attribute that's used as the first priority in sequencing the shipment lines. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_TYPE.
  • Indicates the shipment line attribute name and sorting option that's used as the first priority in sequencing the shipment lines.
  • Title: Priority 2
    Abbreviation of the shipment line attribute that's used as the second priority in sequencing the shipment lines. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_TYPE.
  • Indicates the shipment line attribute name and sorting option that's used as the second priority in sequencing the shipment lines.
  • Title: Priority 3
    Abbreviation of the shipment line attribute that's used as the third priority in sequencing the shipment lines. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_TYPE.
  • Indicates the shipment line attribute name and sorting option that's used as the third priority in sequencing the shipment lines.
  • Title: Priority 4
    Abbreviation of the shipment line attribute that's used as the fourth priority in sequencing the shipment lines. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_TYPE.
  • Indicates the shipment line attribute name and sorting option that's used as the fourth priority in sequencing the shipment lines.
  • Title: Priority 5
    Abbreviation of the shipment line attribute that's used as the fifth priority in sequencing the shipment lines. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_TYPE.
  • Indicates the shipment line attribute name and sorting option that's used as the fifth priority in sequencing the shipment lines.
  • Value that indicates whether the sequencing of shipment lines based on the attribute assigned to priority 1 is in ascending or descending order. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_SORT.
  • Value that indicates whether the sequencing of shipment lines based on the attribute assigned to priority 2 is in ascending or descending order. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_SORT.
  • Value that indicates whether the sequencing of shipment lines based on the attribute assigned to priority 3 is in ascending or descending order. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_SORT.
  • Value that indicates whether the sequencing of shipment lines based on the attribute assigned to priority 4 is in ascending or descending order. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_SORT.
  • Value that indicates whether the sequencing of shipment lines based on the attribute assigned to priority 5 is in ascending or descending order. A list of acceptable values is defined in the lookup WSH_PICK_SEQUENCE_RULE_SORT.
  • Title: Start Date
    Date when the release sequence rule becomes active.
Back to Top

Examples

This example describes how to get all release sequence rules.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/releaseSequenceRules?onlyData=true"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "CreatedBy": "SEED_DATA_FROM_APPLICATION",
            "CreationDate": "2015-07-05T15:52:15+00:00",
            "Description": "Scheduled Ship Date is a default release sequence rule for shipping.",
            "EndDateActive": null,
            "LastUpdateDate": "2022-12-29T12:49:37.689+00:00",
            "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION",
            "PickSequenceRuleId": -1,
            "PickSequenceRuleName": "Default: Scheduled Ship Date",
            "Priority1Code": "ScheduleDate",
            "Sort1Code": "A",
            "Priority2Code": null,
            "Sort2Code": null,
            "Priority3Code": null,
            "Sort3Code": null,
            "Priority4Code": null,
            "Sort4Code": null,
            "Priority5Code": null,
            "Sort5Code": null,
            "StartDateActive": "2014-05-15T12:04:56+00:00",
            "Priority1Output": "Scheduled ship date, Ascending",
            "Priority2Output": "",
            "Priority3Output": "",
            "Priority4Output": "",
            "Priority5Output": ""
        },
        {
            "CreatedBy": "1000049",
            "CreationDate": "2000-06-15T13:29:42+00:00",
            "Description": "End of Month Rush - ship high value first",
            "EndDateActive": null,
            "LastUpdateDate": "2000-06-15T13:36:58+00:00",
            "LastUpdatedBy": "1000049",
            "PickSequenceRuleId": 1,
            "PickSequenceRuleName": "End of Month",
            "Priority1Code": "InvoiceValue",
            "Sort1Code": "D",
            "Priority2Code": "ShipmentPri",
            "Sort2Code": "D",
            "Priority3Code": "ScheduleDate",
            "Sort3Code": "A",
            "Priority4Code": null,
            "Sort4Code": null,
            "Priority5Code": null,
            "Sort5Code": null,
            "StartDateActive": "2000-06-15T00:00:00+00:00",
            "Priority1Output": "Outstanding invoice value, Descending",
            "Priority2Output": "Shipping priority, Descending",
            "Priority3Output": "Scheduled ship date, Ascending",
            "Priority4Output": "",
            "Priority5Output": ""
        },
        {
            "CreatedBy": "1028",
            "CreationDate": "1997-12-30T14:55:28+00:00",
            "Description": "All Standard Orders",
            "EndDateActive": null,
            "LastUpdateDate": "1997-12-30T14:55:45+00:00",
            "LastUpdatedBy": "1028",
            "PickSequenceRuleId": 1000,
            "PickSequenceRuleName": "All Standard Orders",
            "Priority1Code": "ScheduleDate",
            "Sort1Code": "A",
            "Priority2Code": "ShipmentPri",
            "Sort2Code": "A",
            "Priority3Code": "OrderId",
            "Sort3Code": "A",
            "Priority4Code": null,
            "Sort4Code": null,
            "Priority5Code": null,
            "Sort5Code": null,
            "StartDateActive": "1997-12-30T00:00:00+00:00",
            "Priority1Output": "Scheduled ship date, Ascending",
            "Priority2Output": "Shipping priority, Ascending",
            "Priority3Output": "Sales order, Ascending",
            "Priority4Output": "",
            "Priority5Output": ""
        },
        {
            "CreatedBy": "1653",
            "CreationDate": "1998-01-13T10:57:25+00:00",
            "Description": "Schedule Date, Ascending, Shipment Priority Descending",
            "EndDateActive": null,
            "LastUpdateDate": "1998-01-13T10:57:25+00:00",
            "LastUpdatedBy": "1653",
            "PickSequenceRuleId": 1100,
            "PickSequenceRuleName": "Sched Date Shipment Priority",
            "Priority1Code": "ScheduleDate",
            "Sort1Code": "A",
            "Priority2Code": "ShipmentPri",
            "Sort2Code": "D",
            "Priority3Code": null,
            "Sort3Code": null,
            "Priority4Code": null,
            "Sort4Code": null,
            "Priority5Code": null,
            "Sort5Code": null,
            "StartDateActive": "1998-01-13T00:00:00+00:00",
            "Priority1Output": "Scheduled ship date, Ascending",
            "Priority2Output": "Shipping priority, Descending",
            "Priority3Output": "",
            "Priority4Output": "",
            "Priority5Output": ""
        },
        {
            "CreatedBy": "1653",
            "CreationDate": "1998-01-13T11:00:11+00:00",
            "Description": "Outstanding Invoice Value, Descending",
            "EndDateActive": null,
            "LastUpdateDate": "1998-01-13T11:00:11+00:00",
            "LastUpdatedBy": "1653",
            "PickSequenceRuleId": 1101,
            "PickSequenceRuleName": "Outstanding Invoice Value",
            "Priority1Code": "InvoiceValue",
            "Sort1Code": "D",
            "Priority2Code": null,
            "Sort2Code": null,
            "Priority3Code": null,
            "Sort3Code": null,
            "Priority4Code": null,
            "Sort4Code": null,
            "Priority5Code": null,
            "Sort5Code": null,
            "StartDateActive": "1998-01-13T00:00:00+00:00",
            "Priority1Output": "Outstanding invoice value, Descending",
            "Priority2Output": "",
            "Priority3Output": "",
            "Priority4Output": "",
            "Priority5Output": ""
        }
    ],
    "count": 5,
    "hasMore": true,
    "limit": 5,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/releaseSequenceRules",
            "name": "releaseSequenceRules",
            "kind": "collection"
        }
    ]
}
Back to Top