Jump to

• Request
• Response

Get all assignment sets

get

/fscmRestApi/resources/11.13.18.05/sourcingAssignmentSets

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 Find sourcing assignment sets according to the sourcing assignment set identifier.
    Finder Variables
    • AssignmentSetId; integer; Value that uniquely identifies the sourcing assignment set.
• 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:
  

  • AssignmentSetId; integer; Value that uniquely identifies the assignment set.
  • AssignmentSetName; string; Name of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain.
  • CategorySetId; integer; Value that uniquely identifies the catalog or category set that determines the list of item categories used in the assignment set.
  • CategorySetName; string; Name of the product catalog or category set that determines the list of product categories used in the assignment set.
  • CreatedBy; string; User who created the assignment set.
  • CreationDate; string; Date when the user created the assignment set.
  • Description; string; Description of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain.
  • LastUpdateDate; string; Date when the user most recently updated the assignment set.
  • LastUpdatedBy; string; User who most recently updated the assignment set.
  • SubinventoryPlanningEnabledFlag; boolean; Contains one of the following values: 1 or 2. If 1, then the assignment set supports sourcing from subinventories. If 2, then the assignment set doesn't support sourcing from subinventories. This attribute doesn't have a default value.
• 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:
  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.

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

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/sourcingAssignmentSets-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SupplyChainPlanning",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object sourcingAssignmentSets-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/sourcingAssignmentSets-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 : sourcingAssignmentSets-item-response

Type: object

Show Source

• AssignmentSetId: integer
  Value that uniquely identifies the assignment set.
• AssignmentSetName: string
  Title: Name

  Maximum Length: 34

  Name of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain.
• CategorySetId: integer (int64)
  Value that uniquely identifies the catalog or category set that determines the list of item categories used in the assignment set.
• CategorySetName: string
  Name of the product catalog or category set that determines the list of product categories used in the assignment set.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the assignment set.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the assignment set.
• Description: string
  Title: Description

  Maximum Length: 80

  Description of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the assignment set.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the assignment set.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourcingAssignments: array Sourcing Assignments
  Title: Sourcing Assignments

  The Sourcing Assignments resource manages assignments of sourcing rules at various levels.
• SubinventoryPlanningEnabledFlag: boolean
  Contains one of the following values: 1 or 2. If 1, then the assignment set supports sourcing from subinventories. If 2, then the assignment set doesn't support sourcing from subinventories. This attribute doesn't have a default value.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the assignment set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the assignment set.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the assignment set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"80",
            "type":"string",
            "description":"Description of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain.",
            "nullable":true,
            "x-queryable":true
        },
        "SourcingAssignments":{
            "title":"Sourcing Assignments",
            "type":"array",
            "description":"The Sourcing Assignments resource manages assignments of sourcing rules at various levels.",
            "items":{
                "$ref":"#/components/schemas/sourcingAssignmentSets-SourcingAssignments-item-response"
            }
        },
        "SubinventoryPlanningEnabledFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: 1 or 2. If 1, then the assignment set supports sourcing from subinventories. If 2, then the assignment set doesn't support sourcing from subinventories. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategorySetName":{
            "type":"string",
            "description":"Name of the product catalog or category set that determines the list of product categories used in the assignment set.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentSetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assignment set.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AssignmentSetName":{
            "title":"Name",
            "maxLength":"34",
            "type":"string",
            "description":"Name of the assignment set that specifies the sourcing rules and bills of distribution to use for material flow in the supply chain.",
            "nullable":false,
            "x-queryable":true
        },
        "CategorySetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the catalog or category set that determines the list of item categories used in the assignment set.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the assignment set.",
            "format":"date-time",
            "nullable":false,
            "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 : Sourcing Assignments

Type: array

Title: Sourcing Assignments

The Sourcing Assignments resource manages assignments of sourcing rules at various levels.

Show Source

• Array of: object sourcingAssignmentSets-SourcingAssignments-item-response

{
    "title":"Sourcing Assignments",
    "type":"array",
    "description":"The Sourcing Assignments resource manages assignments of sourcing rules at various levels.",
    "items":{
        "$ref":"#/components/schemas/sourcingAssignmentSets-SourcingAssignments-item-response"
    }
}

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."
        }
    }
}

Nested Schema : sourcingAssignmentSets-SourcingAssignments-item-response

Type: object

Show Source

• AssignmentId: integer
  Value that uniquely identifies the assignment.
• AssignmentType: string
  Type of assignment that represents the level assigned to the sourcing rule or bill of distribution. Valid values include Item Instance, Organization, Customer, and so on.
• CategoryId: integer (int64)
  Title: Category

  Value that uniquely identifies the item category to which the sourcing rule is assigned.
• CategoryName: string
  Title: Category

  Maximum Length: 163

  Name of the item category to which the sourcing rule is assigned.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the assignment.
• CreationDate: string (date-time)
  Read Only: true

  Date when the user created the assignment.
• CustomerName: string
  Name of the customer to which the sourcing rule is assigned.
• CustomerSite: string
  Name of the customer site to which the sourcing rule is assigned.
• DemandClassCode: string
  Code that identifies the demand class to which the sourcing rule is assigned.
• DemandClassId: integer (int64)
  Title: Demand Class

  Value that uniquely identifies the demand class to which the sourcing rule is assigned.
• InventoryItemId: integer
  Title: Item

  Value that uniquely identifies the item to which the sourcing rule is assigned.
• ItemName: string
  Read Only: true

  Maximum Length: 300

  Name of the item to which the sourcing rule is assigned.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the user most recently updated the assignment.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Short code that identifies the organization to which a sourcing rule is assigned.
• OrganizationId: integer
  Title: Organization

  Value that represents the organization to which a sourcing rule is assigned.
• OrgSubInventoryCode: string
  Name of the subinventory to which the sourcing rule is assigned.
• PartnerId: integer
  Title: Customer

  Value that uniquely identifies the customer to which the sourcing rule is assigned.
• RegionCode: string
  Code that identifies the region to which the sourcing rule is assigned.
• RegionId: integer
  Title: Region

  Value that uniquely identifies the either the region or the zone to which the sourcing rule is assigned.
• ShipToSiteId: integer
  Title: Customer Site

  Value that uniquely identifies the customer site to which the sourcing rule is assigned.
• SourcingRuleOrBillOfDistributionId: integer
  Title: Sourcing Rule or Bill of Distribution

  Value that uniquely identifies the sourcing rule or bill of distribution that's assigned.
• SourcingRuleOrBillOfDistributionName: string
  Name of the sourcing rule or bill of distribution that's assigned.
• SourcingRuleType: string
  Value that represents the type of the assigned rule. Valid values include Sourcing Rule and Bill of Distribution, which is based on the Sourcing Rule Type Code attribute.
• SubInventoryId: integer
  Value that uniquely identifies the subinventory to which the sourcing rule is assigned.
• ZoneCode: string
  Code that identifies the zone to which the sourcing rule is assigned.

{
    "type":"object",
    "properties":{
        "CategoryId":{
            "title":"Category",
            "type":"integer",
            "description":"Value that uniquely identifies the item category to which the sourcing rule is assigned.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the assignment.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RegionCode":{
            "type":"string",
            "description":"Code that identifies the region to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandClassId":{
            "title":"Demand Class",
            "type":"integer",
            "description":"Value that uniquely identifies the demand class to which the sourcing rule is assigned.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Customer",
            "type":"integer",
            "description":"Value that uniquely identifies the customer to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"Value that represents the organization to which a sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "SourcingRuleOrBillOfDistributionName":{
            "type":"string",
            "description":"Name of the sourcing rule or bill of distribution that's assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerSite":{
            "type":"string",
            "description":"Name of the customer site to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assignment.",
            "nullable":false,
            "x-hints":{
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":"300",
            "type":"string",
            "description":"Name of the item to which the sourcing rule is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Short code that identifies the organization to which a sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerName":{
            "type":"string",
            "description":"Name of the customer to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "SourcingRuleOrBillOfDistributionId":{
            "title":"Sourcing Rule or Bill of Distribution",
            "type":"integer",
            "description":"Value that uniquely identifies the sourcing rule or bill of distribution that's assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgSubInventoryCode":{
            "type":"string",
            "description":"Name of the subinventory to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item",
            "type":"integer",
            "description":"Value that uniquely identifies the item to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "SubInventoryId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subinventory to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "DemandClassCode":{
            "type":"string",
            "description":"Code that identifies the demand class to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "AssignmentType":{
            "type":"string",
            "description":"Type of assignment that represents the level assigned to the sourcing rule or bill of distribution. Valid values include Item Instance, Organization, Customer, and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "ZoneCode":{
            "type":"string",
            "description":"Code that identifies the zone to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"163",
            "type":"string",
            "description":"Name of the item category to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "SourcingRuleType":{
            "type":"string",
            "description":"Value that represents the type of the assigned rule. Valid values include Sourcing Rule and Bill of Distribution, which is based on the Sourcing Rule Type Code attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "RegionId":{
            "title":"Region",
            "type":"integer",
            "description":"Value that uniquely identifies the either the region or the zone to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipToSiteId":{
            "title":"Customer Site",
            "type":"integer",
            "description":"Value that uniquely identifies the customer site to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the assignment.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

Back to Top