Jump to

• Request
• Response

Get one supply source

get

/fscmRestApi/resources/11.13.18.05/supplySources/{SourcingRuleId}

Request

Path Parameters

• SourcingRuleId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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(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.

Body ()

Root Schema : supplySources-item-response

Type: object

Show Source

• AllocationPercent: number
  Read Only: true

  Percentage of replenishment from each source.
• 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.
• CarrierName: string
  Name of the carrier used in the sourcing rule.
• Category: string
  Name of the item category to which the sourcing rule is assigned.
• CreateMovementRequestFlag: boolean
  Read Only: true

  Value that indicates whether to create movement requests as part of the replenishment based on this sourcing rule. Contains one of the following values: 1 or 2. If 1, then create movement request. If 2, then don't create movement request. This attribute doesn't have a default value.
• DisableDate: string (date)
  Read Only: true

  Date until when the set of sources specified for this destination are effective. If blank, then the sources are effective indefinitely.
• EffectiveDate: string (date)
  Read Only: true

  Date when the set of sources specified for this destination are effective.
• FromQuantity: number
  Read Only: true

  Lower limit for quantity-based sourcing. This source is used when the required quantity is between the two limits.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModeOfTransport: string
  Name of the transportation mode used in the sourcing rule. The transportation mode is the type of transportation provided such as truck, air, or boat.
• OptionClassItemName: string
  Read Only: true

  Maximum Length: 300

  Name of the option or option class item that's excluded for this source.
• OrganizationAssignmentType: string
  Contains one of the following values: Global or Local. If Global, then the sourcing rule is applicable to all organizations. If Local, then the sourcing rule is for the organization specified in the OrganizationCode attribute. This attribute doesn't have a default value.
• OrganizationCode: string
  Short code that identifies the organization to which a sourcing rule is assigned.
• Rank: number
  Read Only: true

  Rank for each source of supply named in a sourcing rule.
• ReleaseToInstanceCode: string
  Code that indicates the source application of the source supplier or organization.
• ServiceLevel: string
  Name of the carrier service level used in the sourcing rule. The carrier service level is the type of transportation service provided, such as ground truck or 2 day air.
• ShipMethod: string
  Read Only: true

  Maximum Length: 30

  Method of shipping used in the sourcing rule.
• SourceOrganizationCode: string
  Code that identifies the source organization for make and transfer sourcing rules.
• SourcesSubInventoryCode: string
  Code that identifies the subinventory for transfer sourcing rules that are enabled for subinventory planning.
• SourceType: string
  Type of the source. Valid values include Make, Buy, or Transfer. These values depend on the attribute Source Type Code.
• SourcingRuleId: integer (int64)
  Read Only: true

  Value that uniquely identifies the sourcing rule.
• SourcingRuleName: string
  Read Only: true

  Maximum Length: 80

  Name of the sourcing rule that specifies how to replenish items in an organization, such as purchased items in plants.
• SubInventoryCode: string
  Code of the subinventory to which the sourcing rule is assigned.
• SubinventoryPlanningEnabledFlag: boolean
  Read Only: true

  Contains one of the following values: true or false. If true, then the sourcing rule is enabled for subinventory level planning. If false, then the sourcing rule isn't enabled for subinventory level planning. This attribute doesn't have a default value.
• SupplierName: string
  Name of the supplier for buy sourcing rules.
• SupplierSiteCode: string
  Code that identifies the supplier site for buy sourcing rules.
• ToQuantity: number
  Read Only: true

  Upper limit for quantity-based sourcing. This source is used when the required quantity is between the two limits.
• TransitLeadTime: number
  Number of days that the supply will be in transit between two locations.
• UOMCode: string
  Read Only: true

  Maximum Length: 3

  Code that identifies the unit of measure for the quantity.

{
    "type":"object",
    "properties":{
        "ServiceLevel":{
            "type":"string",
            "description":"Name of the carrier service level used in the sourcing rule. The carrier service level is the type of transportation service provided, such as ground truck or 2 day air.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipMethod":{
            "maxLength":30,
            "type":"string",
            "description":"Method of shipping used in the sourcing rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Category":{
            "type":"string",
            "description":"Name of the item category to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationAssignmentType":{
            "type":"string",
            "description":"Contains one of the following values: Global or Local. If Global, then the sourcing rule is applicable to all organizations. If Local, then the sourcing rule is for the organization specified in the OrganizationCode attribute. This attribute doesn't have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceType":{
            "type":"string",
            "description":"Type of the source. Valid values include Make, Buy, or Transfer. These values depend on the attribute Source Type Code.",
            "nullable":true,
            "x-queryable":true
        },
        "OptionClassItemName":{
            "maxLength":300,
            "type":"string",
            "description":"Name of the option or option class item that's excluded for this source.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubInventoryCode":{
            "type":"string",
            "description":"Code of the subinventory to which the sourcing rule is assigned.",
            "nullable":true,
            "x-queryable":true
        },
        "CreateMovementRequestFlag":{
            "type":"boolean",
            "description":"Value that indicates whether to create movement requests as part of the replenishment based on this sourcing rule. Contains one of the following values: 1 or 2. If 1, then create movement request. If 2, then don't create movement request. This attribute doesn't have a default value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ToQuantity":{
            "type":"number",
            "description":"Upper limit for quantity-based sourcing. This source is used when the required quantity is between the two limits.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierSiteCode":{
            "type":"string",
            "description":"Code that identifies the supplier site for buy sourcing rules.",
            "nullable":true,
            "x-queryable":true
        },
        "SubinventoryPlanningEnabledFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the sourcing rule is enabled for subinventory level planning. If false, then the sourcing rule isn't enabled for subinventory level planning. This attribute doesn't have a default value.",
            "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"
            }
        },
        "DisableDate":{
            "type":"string",
            "description":"Date until when the set of sources specified for this destination are effective. If blank, then the sources are effective indefinitely.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReleaseToInstanceCode":{
            "type":"string",
            "description":"Code that indicates the source application of the source supplier or organization.",
            "nullable":true,
            "x-queryable":true
        },
        "FromQuantity":{
            "type":"number",
            "description":"Lower limit for quantity-based sourcing. This source is used when the required quantity is between the two limits.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":3,
            "type":"string",
            "description":"Code that identifies the unit of measure for the quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CarrierName":{
            "type":"string",
            "description":"Name of the carrier used in the sourcing rule.",
            "nullable":true,
            "x-queryable":true
        },
        "SourcingRuleId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sourcing rule.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransitLeadTime":{
            "type":"number",
            "description":"Number of days that the supply will be in transit between two locations.",
            "nullable":true,
            "x-queryable":true
        },
        "Rank":{
            "type":"number",
            "description":"Rank for each source of supply named in a sourcing rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourcingRuleName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the sourcing rule that specifies how to replenish items in an organization, such as purchased items in plants.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourcesSubInventoryCode":{
            "type":"string",
            "description":"Code that identifies the subinventory for transfer sourcing rules that are enabled for subinventory planning.",
            "nullable":true,
            "x-queryable":true
        },
        "AllocationPercent":{
            "type":"number",
            "description":"Percentage of replenishment from each source.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierName":{
            "type":"string",
            "description":"Name of the supplier for buy sourcing rules.",
            "nullable":true,
            "x-queryable":true
        },
        "ModeOfTransport":{
            "type":"string",
            "description":"Name of the transportation mode used in the sourcing rule. The transportation mode is the type of transportation provided such as truck, air, or boat.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganizationCode":{
            "type":"string",
            "description":"Code that identifies the source organization for make and transfer sourcing rules.",
            "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
        },
        "EffectiveDate":{
            "type":"string",
            "description":"Date when the set of sources specified for this destination are effective.",
            "format":"date",
            "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 : 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