Create rules
/fscmRestApi/resources/11.13.18.05/returnRoutingRules
Request
-
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.
-
Upsert-Mode:
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.
- application/json
object
-
CategoryId: integer
(int64)
Value that uniquely identifies the item category.
-
CategoryName: string
Maximum Length:
250
Abbreviation that identifies the item category. -
CategorySetId: integer
(int64)
Value that uniquely identifies the item catalog.
-
CategorySetName: string
Maximum Length:
30
Abbreviation that identifies the item catalog. -
DestinationOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the destination organization. -
DestinationOrganizationId: integer
(int64)
Value that uniquely identifies the destination organization.
-
DestinationSubinventory: string
Maximum Length:
10
Name of destination subinventory. -
EnabledFlag: boolean
Maximum Length:
1
Status of the return routing rule. -
GeographyId: integer
(int64)
Value that uniquely identifies the zone of the customer's address.
-
GeographyName: string
Maximum Length:
360
Abbreviation that identifies the zone of the customer's address. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item being returned.
-
InventoryItemNumber: string
Maximum Length:
300
Number that identifies the inventory item being returned. -
ReturnType: string
Maximum Length:
10
Type of return of return routing rule. Valid values include Defective or Excess. -
RuleId: integer
(int64)
Value that uniquely identifies the return routing rule.
-
SourceOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
SourceSubinventory: string
Maximum Length:
10
Name of source subinventory. -
SourceType: string
Maximum Length:
3
Type of source of the return routing rule. Valid values include Zone or Warehouse.
Response
- application/json
Default Response
-
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.
object
-
CategoryId: integer
(int64)
Value that uniquely identifies the item category.
-
CategoryName: string
Maximum Length:
250
Abbreviation that identifies the item category. -
CategorySetId: integer
(int64)
Value that uniquely identifies the item catalog.
-
CategorySetName: string
Maximum Length:
30
Abbreviation that identifies the item catalog. -
DestinationOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the destination organization. -
DestinationOrganizationId: integer
(int64)
Value that uniquely identifies the destination organization.
-
DestinationSubinventory: string
Maximum Length:
10
Name of destination subinventory. -
EnabledFlag: boolean
Maximum Length:
1
Status of the return routing rule. -
GeographyId: integer
(int64)
Value that uniquely identifies the zone of the customer's address.
-
GeographyName: string
Maximum Length:
360
Abbreviation that identifies the zone of the customer's address. -
InventoryItemId: integer
(int64)
Value that uniquely identifies the inventory item being returned.
-
InventoryItemNumber: string
Maximum Length:
300
Number that identifies the inventory item being returned. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReturnType: string
Maximum Length:
10
Type of return of return routing rule. Valid values include Defective or Excess. -
RuleId: integer
(int64)
Value that uniquely identifies the return routing rule.
-
SourceOrganizationCode: string
Maximum Length:
18
Abbreviation that identifies the source organization. -
SourceOrganizationId: integer
(int64)
Value that uniquely identifies the source organization.
-
SourceSubinventory: string
Maximum Length:
10
Name of source subinventory. -
SourceType: string
Maximum Length:
3
Type of source of the return routing rule. Valid values include Zone or Warehouse.
array
Links
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to create rules.
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/returnRoutingRules"
Example 1 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "DestinationOrganizationId": 207, "DestinationOrganizationCode": null, "DestinationSubinventory": "Depot", "CategorySetId": null, "CategoryId": null, "CategoryName": "Desktop Computers", "CategorySetName": null, "InventoryItemId": null, "InventoryItemNumber": "FS54888", "SourceType": "INV", "ReturnType": "DEFECTIVE", "SourceOrganizationId": 5702, "SourceOrganizationCode": null, "SourceSubinventory": "FS_Truck1", "Enabled":false, "GeographyId":null, "GeographyName":null }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "RuleId": 300100190446377, "SourceType": "INV", "SourceOrganizationId": 5702, "SourceOrganizationCode": null, "SourceSubinventory": "FS_Truck1", "ReturnType": "DEFECTIVE", "InventoryItemId": 8980, "InventoryItemNumber": "FS54888", "DestinationOrganizationId": 207, "DestinationOrganizationCode": null, "DestinationSubinventory": "Depot", "Enabled": false, "CategorySetId": null, "CategoryId": 1373, "CategoryName": "Desktop Computers", "CategorySetName": null, "GeographyId":null, "GeographyName":null "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377", "name": "returnRoutingRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377", "name": "returnRoutingRules", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/ReturnTypeLOV", "name": "ReturnTypeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/EnabledLOV", "name": "EnabledLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/InventoryItemIdLOV", "name": "InventoryItemIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/SourceOrganizationIdLOV", "name": "SourceOrganizationIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/CategorySetIdLOV", "name": "CategorySetIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/DestinationSubinventoryLOV", "name": "DestinationSubinventoryLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/SourceTypeLOV", "name": "SourceTypeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/CategeoryIdLOV", "name": "CategeoryIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/DestinationOrganizationIdLOV", "name": "DestinationOrganizationIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190446377/lov/SourceSubinventoryLOV", "name": "SourceSubinventoryLOV", "kind": "collection" } ] }
Example 2 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the miltiple records that it creates.
{ "parts":[ { "id":"line1", "path":"https://servername/fscmRestApi/resources/version/returnRoutingRules", "operation":"create", "payload":{ "DestinationOrganizationId": 207, "DestinationOrganizationCode": null, "DestinationSubinventory": "Depot", "CategorySetId": null, "CategoryId": null, "CategoryName": "Desktop Computers", "CategorySetName": null, "InventoryItemId": null, "InventoryItemNumber": "FS54888", "SourceType": "INV", "ReturnType": "DEFECTIVE", "SourceOrganizationId": 5702, "SourceOrganizationCode": null, "SourceSubinventory": "FS_Truck1", "Enabled": true, "GeographyId":null, "GeographyName":null } }, { "id":"line2", "path":"https://servername/fscmRestApi/resources/version/returnRoutingRules", "operation":"create", "payload":{ "DestinationOrganizationId": 207, "DestinationOrganizationCode": null, "DestinationSubinventory": "Depot", "CategorySetId": null, "CategoryId": null, "CategoryName": "Desktop Computers", "CategorySetName": null, "InventoryItemId": null, "InventoryItemNumber": "FS54888", "SourceType": "INV", "ReturnType": "DEFECTIVE", "SourceOrganizationId": 5702, "SourceOrganizationCode": null, "SourceSubinventory": "FS_Truck1", "Enabled": false, "GeographyId":null, "GeographyName":null } } ] }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "parts": [ { "id": "line1", "path": "https://servername/fscmRestApi/resources/version/returnRoutingRules", "operation": "create", "payload": { "RuleId": 300100190447181, "SourceType": "INV", "SourceOrganizationId": 5702, "SourceOrganizationCode": "FST", "SourceSubinventory": "FS_Truck1", "ReturnType": "DEFECTIVE", "InventoryItemId": 8980, "InventoryItemNumber": "FS54888", "DestinationOrganizationId": 207, "DestinationOrganizationCode": "M1", "DestinationSubinventory": "Depot", "Enabled": true, "CategorySetId": null, "CategoryId": 1373, "CategoryName": "Desktop Computers", "CategorySetName": null, "GeographyId":null, "GeographyName":null "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181", "name": "returnRoutingRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181", "name": "returnRoutingRules", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/ReturnTypeLOV", "name": "ReturnTypeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/EnabledLOV", "name": "EnabledLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/InventoryItemIdLOV", "name": "InventoryItemIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/SourceOrganizationIdLOV", "name": "SourceOrganizationIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/CategorySetIdLOV", "name": "CategorySetIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/DestinationSubinventoryLOV", "name": "DestinationSubinventoryLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/SourceTypeLOV", "name": "SourceTypeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/CategeoryIdLOV", "name": "CategeoryIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/DestinationOrganizationIdLOV", "name": "DestinationOrganizationIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447181/lov/SourceSubinventoryLOV", "name": "SourceSubinventoryLOV", "kind": "collection" } ] } }, { "id": "line2", "path": "https://servername/fscmRestApi/resources/version/returnRoutingRules", "operation": "create", "payload": { "RuleId": 300100190447182, "SourceType": "INV", "SourceOrganizationId": 5702, "SourceOrganizationCode": "FST", "SourceSubinventory": "FS_Truck1", "ReturnType": "DEFECTIVE", "InventoryItemId": 8980, "InventoryItemNumber": "FS54888", "DestinationOrganizationId": 207, "DestinationOrganizationCode": "M1", "DestinationSubinventory": "Depot", "Enabled": false, "CategorySetId": null, "CategoryId": 1373, "CategoryName": "Desktop Computers", "CategorySetName": null, "GeographyId":null, "GeographyName":null "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182", "name": "returnRoutingRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182", "name": "returnRoutingRules", "kind": "item" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/ReturnTypeLOV", "name": "ReturnTypeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/EnabledLOV", "name": "EnabledLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/InventoryItemIdLOV", "name": "InventoryItemIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/SourceOrganizationIdLOV", "name": "SourceOrganizationIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/CategorySetIdLOV", "name": "CategorySetIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/DestinationSubinventoryLOV", "name": "DestinationSubinventoryLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/SourceTypeLOV", "name": "SourceTypeLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/CategeoryIdLOV", "name": "CategeoryIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/DestinationOrganizationIdLOV", "name": "DestinationOrganizationIdLOV", "kind": "collection" }, { "rel": "lov", "href": "https://servername/fscmRestApi/resources/version/returnRoutingRules/300100190447182/lov/SourceSubinventoryLOV", "name": "SourceSubinventoryLOV", "kind": "collection" } ] } } ] }