Jump to

• Request
• Response

Get all item relationships

get

/fscmRestApi/resources/11.13.18.05/supplyPlans/{PlanId}/child/ItemRelationships

Request

Path Parameters

• PlanId(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
• 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 Finds item relationships according to the primary key criteria.
    Finder Variables
    • OrganizationId; number; Value that uniquely identifies the organization associated with the item relationship.
    • PartitionKey; integer; Value that uniquely identifies the part key associated with the item relationship.
    • PlanId; integer; Value that uniquely identifies the plan associated with the item relationship.
    • SubstituteId; integer; Value that uniquely identifies the substitute associated with the item relationship.
  • filterByLevel Indicates the current level of the item relationship.
    Finder Variables
    • bAllLevels; integer; Indicates the current level of the item relationship.
    • bBasePlanId; integer;
    • bLowerItemId; integer; Value that uniquely identifies the lower item.
• 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:
  

  • ControlledAt; string; Indicates whether the item relationship is controlled at the master level or the organization level.
  • CreatedBy; string; User who created the item relationship.
  • CreationDate; string; Date when the user created the item relationship.
  • CurrentLevel; number; Indicates the current level of the item relationship.
  • Customer; string; Unique identifier of the customer associated with the item relationship.
  • CustomerId; integer; Unique identifier of the customer ID associated with the item relationship.
  • CustomerSite; string; Unique identifier of the customer site associated with the item relationship.
  • CustomerSiteId; integer; Unique identifier of the customer site ID associated with the item relationship.
  • DisableDate; string; Date the item relationship is disabled.
  • EffectiveDate; string; Date the item relationship is effective.
  • HigherItemDescription; string; Description of the higher-level item in the item relationship.
  • HigherItemId; integer; Unique identifier of the higher-level item.
  • HigherItemName; string; Name of the higher-level item.
  • HighestItemId; integer; Unique identifier of the highest item.
  • InferredIndicator; number; Indicates an inferred item relationship.
  • InferredMeaning; string; Indicates an inferred item relationship.
  • InheritedIndicator; number; Indicates an inherited item relationship.
  • InheritedMeaning; string; Indicates an inherited item relationship.
  • LastUpdateDate; string; Date when the user most recently updated the item relationship.
  • LastUpdateLogin; string; Sign-in used for updating the item relationship.
  • LastUpdatedBy; string; User who most recently updated the item relationship.
  • LowerItemDescription; string; Description of the lower item involved in item relationship.
  • LowerItemId; integer; Value that uniquely identifies the lower item.
  • LowerItemName; string; Name of the lower item.
  • MasterOrganizationCode; string; Unique identifier of the master organization code.
  • MasterOrganizationId; number; Value that uniquely identifies the master organization.
  • OrganizationCode; string; Unique identifier of the organization code.
  • OrganizationId; number; Value that uniquely identifies the organization.
  • OrganizationIndicator; number; Indicates an organization independent item relationship.
  • PartitionKey; integer; Unique identifier of the part key.
  • PlanId; integer; Value that uniquely identifies the plan.
  • PlanningEnabledIndicator; number; Indicates whether planning is enabled.
  • PlanningEnabledMeaning; string; Indicates whether planning is enabled.
  • Rank; number; Rank of the item relationship.
  • ReciprocalIndicator; number; Indicates whether the item relationship is reciprocal.
  • ReciprocalMeaning; string; Indicates whether the item relationship is reciprocal.
  • RelationshipDescription; string; Description of the item relationship.
  • RelationshipTypeMeaning; string; Type of the item relationship.
  • SubstituteId; integer; Unique identifier of the substitute.
• 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: 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.

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 : supplyPlans-ItemRelationships

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":{
        "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."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/supplyPlans-ItemRelationships-item-response"
            }
        },
        "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"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object supplyPlans-ItemRelationships-item-response

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

Type: object

Show Source

• ControlledAt: string
  Read Only: true

  Maximum Length: 4000

  Indicates whether the item relationship is controlled at the master level or the organization level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Date when the user created the item relationship.
• CurrentLevel: number
  Read Only: true

  Indicates the current level of the item relationship.
• Customer: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier of the customer associated with the item relationship.
• CustomerId: integer (int64)
  Read Only: true

  Unique identifier of the customer ID associated with the item relationship.
• CustomerSite: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier of the customer site associated with the item relationship.
• CustomerSiteId: integer (int64)
  Read Only: true

  Unique identifier of the customer site ID associated with the item relationship.
• DisableDate: string (date)
  Read Only: true

  Date the item relationship is disabled.
• EffectiveDate: string (date)
  Read Only: true

  Date the item relationship is effective.
• HigherItemDescription: string
  Read Only: true

  Maximum Length: 4000

  Description of the higher-level item in the item relationship.
• HigherItemId: integer (int64)
  Read Only: true

  Unique identifier of the higher-level item.
• HigherItemName: string
  Read Only: true

  Maximum Length: 4000

  Name of the higher-level item.
• HighestItemId: integer (int64)
  Read Only: true

  Unique identifier of the highest item.
• InferredIndicator: number
  Read Only: true

  Indicates an inferred item relationship.
• InferredMeaning: string
  Read Only: true

  Maximum Length: 4000

  Indicates an inferred item relationship.
• InheritedIndicator: number
  Read Only: true

  Indicates an inherited item relationship.
• InheritedMeaning: string
  Read Only: true

  Maximum Length: 4000

  Indicates an inherited item relationship.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

  User who most recently updated the item relationship.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Sign-in used for updating the item relationship.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LowerItemDescription: string
  Read Only: true

  Maximum Length: 4000

  Description of the lower item involved in item relationship.
• LowerItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the lower item.
• LowerItemName: string
  Read Only: true

  Maximum Length: 4000

  Name of the lower item.
• MasterOrganizationCode: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier of the master organization code.
• MasterOrganizationId: number
  Read Only: true

  Value that uniquely identifies the master organization.
• OrganizationCode: string
  Read Only: true

  Maximum Length: 4000

  Unique identifier of the organization code.
• OrganizationId: number
  Read Only: true

  Value that uniquely identifies the organization.
• OrganizationIndicator: number
  Read Only: true

  Indicates an organization independent item relationship.
• PartitionKey: integer (int64)
  Read Only: true

  Unique identifier of the part key.
• PlanId: integer (int64)
  Read Only: true

  Value that uniquely identifies the plan.
• PlanningEnabledIndicator: number
  Read Only: true

  Indicates whether planning is enabled.
• PlanningEnabledMeaning: string
  Read Only: true

  Maximum Length: 4000

  Indicates whether planning is enabled.
• Rank: number
  Read Only: true

  Rank of the item relationship.
• ReciprocalIndicator: number
  Read Only: true

  Indicates whether the item relationship is reciprocal.
• ReciprocalMeaning: string
  Read Only: true

  Maximum Length: 4000

  Indicates whether the item relationship is reciprocal.
• RelationshipDescription: string
  Read Only: true

  Maximum Length: 240

  Description of the item relationship.
• RelationshipTypeMeaning: string
  Read Only: true

  Maximum Length: 4000

  Type of the item relationship.
• SubstituteId: integer (int64)
  Read Only: true

  Unique identifier of the substitute.

{
    "type":"object",
    "properties":{
        "ControlledAt":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates whether the item relationship is controlled at the master level or the organization level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the user created the item relationship.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentLevel":{
            "type":"number",
            "description":"Indicates the current level of the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Customer":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the customer associated with the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerId":{
            "type":"integer",
            "description":"Unique identifier of the customer ID associated with the item relationship.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerSite":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the customer site associated with the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerSiteId":{
            "type":"integer",
            "description":"Unique identifier of the customer site ID associated with the item relationship.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DisableDate":{
            "type":"string",
            "description":"Date the item relationship is disabled.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveDate":{
            "type":"string",
            "description":"Date the item relationship is effective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HigherItemDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the higher-level item in the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HigherItemId":{
            "type":"integer",
            "description":"Unique identifier of the higher-level item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HigherItemName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the higher-level item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HighestItemId":{
            "type":"integer",
            "description":"Unique identifier of the highest item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InferredIndicator":{
            "type":"number",
            "description":"Indicates an inferred item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InferredMeaning":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates an inferred item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedIndicator":{
            "type":"number",
            "description":"Indicates an inherited item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InheritedMeaning":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates an inherited item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the user most recently updated the item relationship.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Sign-in used for updating the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LowerItemDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Description of the lower item involved in item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LowerItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the lower item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LowerItemName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the lower item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterOrganizationCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the master organization code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MasterOrganizationId":{
            "type":"number",
            "description":"Value that uniquely identifies the master organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":4000,
            "type":"string",
            "description":"Unique identifier of the organization code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"number",
            "description":"Value that uniquely identifies the organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationIndicator":{
            "type":"number",
            "description":"Indicates an organization independent item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartitionKey":{
            "type":"integer",
            "description":"Unique identifier of the part key.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that uniquely identifies the plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanningEnabledIndicator":{
            "type":"number",
            "description":"Indicates whether planning is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanningEnabledMeaning":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates whether planning is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Rank":{
            "type":"number",
            "description":"Rank of the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReciprocalIndicator":{
            "type":"number",
            "description":"Indicates whether the item relationship is reciprocal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReciprocalMeaning":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates whether the item relationship is reciprocal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipTypeMeaning":{
            "maxLength":4000,
            "type":"string",
            "description":"Type of the item relationship.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubstituteId":{
            "type":"integer",
            "description":"Unique identifier of the substitute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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