Create release sequence rules
post
/fscmRestApi/resources/11.13.18.05/releaseSequenceRules
Request
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Description: string
Title:
Description
Maximum Length:240
Description of the release sequence rule. -
EndDateActive: string
(date-time)
Title:
End Date
Date when the release sequence rule becomes inactive. -
PickSequenceRuleId: integer
(int64)
Value that uniquely identifies the release sequence rule.
-
PickSequenceRuleName(required): string
Title:
Name
Maximum Length:60
Name of the release sequence rule. -
Priority1Code: string
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. -
Priority1Meaning: string
Name 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.
-
Priority1Output: string
Indicates the shipment line attribute name and sorting option that's used as the first priority in sequencing the shipment lines.
-
Priority2Code: string
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. -
Priority2Meaning: string
Name 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.
-
Priority2Output: string
Indicates the shipment line attribute name and sorting option that's used as the second priority in sequencing the shipment lines.
-
Priority3Code: string
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. -
Priority3Meaning: string
Name 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.
-
Priority3Output: string
Indicates the shipment line attribute name and sorting option that's used as the third priority in sequencing the shipment lines.
-
Priority4Code: string
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. -
Priority4Meaning: string
Name 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.
-
Priority4Output: string
Indicates the shipment line attribute name and sorting option that's used as the fourth priority in sequencing the shipment lines.
-
Priority5Code: string
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. -
Priority5Meaning: string
Name 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.
-
Priority5Output: string
Indicates the shipment line attribute name and sorting option that's used as the fifth priority in sequencing the shipment lines.
-
sequenceDFF: array
sequenceDFF
-
Sort1Code: string
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.
-
Sort1Meaning: string
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.
-
Sort2Code: string
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.
-
Sort2Meaning: string
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.
-
Sort3Code: string
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.
-
Sort3Meaning: string
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.
-
Sort4Code: string
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.
-
Sort4Meaning: string
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.
-
Sort5Code: string
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.
-
Sort5Meaning: string
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.
-
StartDateActive: string
(date-time)
Title:
Start Date
Date when the release sequence rule becomes active.
Nested Schema : releaseSequenceRules-sequenceDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context Segment -
PickSequenceRuleId: integer
(int64)
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.
Root Schema : releaseSequenceRules-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the release sequence rule. -
CreationDate: string
(date-time)
Read Only:
true
Date when the user created the release sequence rule. -
Description: string
Title:
Description
Maximum Length:240
Description of the release sequence rule. -
EndDateActive: string
(date-time)
Title:
End Date
Date when the release sequence rule becomes inactive. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the release sequence rule. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the release sequence rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PickSequenceRuleId: integer
(int64)
Value that uniquely identifies the release sequence rule.
-
PickSequenceRuleName: string
Title:
Name
Maximum Length:60
Name of the release sequence rule. -
Priority1Code: string
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. -
Priority1Meaning: string
Name 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.
-
Priority1Output: string
Indicates the shipment line attribute name and sorting option that's used as the first priority in sequencing the shipment lines.
-
Priority2Code: string
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. -
Priority2Meaning: string
Name 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.
-
Priority2Output: string
Indicates the shipment line attribute name and sorting option that's used as the second priority in sequencing the shipment lines.
-
Priority3Code: string
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. -
Priority3Meaning: string
Name 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.
-
Priority3Output: string
Indicates the shipment line attribute name and sorting option that's used as the third priority in sequencing the shipment lines.
-
Priority4Code: string
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. -
Priority4Meaning: string
Name 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.
-
Priority4Output: string
Indicates the shipment line attribute name and sorting option that's used as the fourth priority in sequencing the shipment lines.
-
Priority5Code: string
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. -
Priority5Meaning: string
Name 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.
-
Priority5Output: string
Indicates the shipment line attribute name and sorting option that's used as the fifth priority in sequencing the shipment lines.
-
sequenceDFF: array
sequenceDFF
-
Sort1Code: string
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.
-
Sort1Meaning: string
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.
-
Sort2Code: string
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.
-
Sort2Meaning: string
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.
-
Sort3Code: string
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.
-
Sort3Meaning: string
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.
-
Sort4Code: string
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.
-
Sort4Meaning: string
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.
-
Sort5Code: string
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.
-
Sort5Meaning: string
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.
-
StartDateActive: string
(date-time)
Title:
Start Date
Date when the release sequence rule becomes active.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : releaseSequenceRules-sequenceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context Segment -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PickSequenceRuleId: integer
(int64)
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- sequenceDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/releaseSequenceRules/{PickSequenceRuleId}/child/sequenceDFFParameters:
- PickSequenceRuleId:
$request.path.PickSequenceRuleId
- PickSequenceRuleId: