Jump to

• Request
• Response

Get details of one operation dependency

get

/fscmRestApi/resources/11.13.18.05/demandAndSupplyPlans/{PlanId}/child/operationDependencies/{operationDependenciesUniqID}

Request

Path Parameters

• PlanId(required): integer
  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=
• operationDependenciesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanId, AssemblyItemId, OrganizationId, PartitionKey and WorkDefinitionId ---for the Operation Dependencies resource and used to uniquely identify an instance of Operation Dependencies. The client should not generate the hash key value. Instead, the client should query on the Operation Dependencies collection resource with a filter on the primary key values in order to navigate to a specific instance of Operation Dependencies.
  
  For example: operationDependencies?q=PlanId=<value1>;AssemblyItemId=<value2>;OrganizationId=<value3>;PartitionKey=<value4>;WorkDefinitionId=<value5>

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: 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 : demandAndSupplyPlans-operationDependencies-item-response

Type: object

Show Source

• AssemblyItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the assembly item.
• DependencyType: integer (int32)
  Read Only: true

  Name of the type of dependency setup across operations.
• DependencyTypeValue: string
  Read Only: true

  Maximum Length: 2

  Value that identifies the type of dependency across operations.
• EndDate: string (date)
  Read Only: true

  Value that identifies the end date of the operation dependencies.
• ItemName: string
  Read Only: true

  Maximum Length: 4000

  Name of the item associated with the operation dependencies.
• links: array Links
  Title: Links

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

  Maximum Length: 960

  Name of the next operation within the work definition.
• NextOperationId: integer
  Read Only: true

  Value that uniquely identifies the next operation within the work definition.
• NextOperationNumber: integer (int64)
  Read Only: true

  Value that uniquely identifies the next operation.
• NextOperationType: integer
  Read Only: true

  Name that defines the type of the next operation.
• OrganizationId: integer (int64)
  Read Only: true

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

  Maximum Length: 4000

  Value that uniquely identifies the organization code on the operation dependencies.
• PartitionKey: integer
  Read Only: true

  Value that uniquely identifies the part key associated with the operation dependencies.
• PlanId: integer
  Read Only: true

  Value that indicates the most recent unique value used to identify the plan.
• PreviousOperationDescription: string
  Read Only: true

  Maximum Length: 960

  Name of the previous operation within the work definition.
• PreviousOperationId: integer
  Read Only: true

  Value that uniquely identifies the previous operation within the work definition.
• PreviousOperationNumber: integer (int64)
  Read Only: true

  Value that uniquely identifies the previous operation.
• PreviousOperationType: integer
  Read Only: true

  Name that defines the type of the previous operation.
• StartDate: string (date)
  Read Only: true

  Date when the operation dependencies version started.
• TransferPercent: number
  Read Only: true

  Value that determines how much material is moving from the previous operation to the next operation.
• WorkDefinitionId: integer (int64)
  Read Only: true

  Code that uniquely identifies the work definition used for a make order.
• WorkDefinitionName: string
  Read Only: true

  Maximum Length: 300

  Description of a work definition for an item.

{
    "type":"object",
    "properties":{
        "AssemblyItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the assembly item.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DependencyType":{
            "type":"integer",
            "description":"Name of the type of dependency setup across operations.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "DependencyTypeValue":{
            "maxLength":2,
            "type":"string",
            "description":"Value that identifies the type of dependency across operations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"Value that identifies the end date of the operation dependencies.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the item associated with the operation dependencies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextOperationDescription":{
            "maxLength":960,
            "type":"string",
            "description":"Name of the next operation within the work definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the next operation within the work definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextOperationNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies the next operation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NextOperationType":{
            "type":"integer",
            "description":"Name that defines the type of the next operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationName":{
            "maxLength":4000,
            "type":"string",
            "description":"Value that uniquely identifies the organization code on the operation dependencies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartitionKey":{
            "type":"integer",
            "description":"Value that uniquely identifies the part key associated with the operation dependencies.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanId":{
            "type":"integer",
            "description":"Value that indicates the most recent unique value used to identify the plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousOperationDescription":{
            "maxLength":960,
            "type":"string",
            "description":"Name of the previous operation within the work definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousOperationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the previous operation within the work definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PreviousOperationNumber":{
            "type":"integer",
            "description":"Value that uniquely identifies the previous operation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreviousOperationType":{
            "type":"integer",
            "description":"Name that defines the type of the previous operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Date when the operation dependencies version started.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransferPercent":{
            "type":"number",
            "description":"Value that determines how much material is moving from the previous operation to the next operation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkDefinitionId":{
            "type":"integer",
            "description":"Code that uniquely identifies the work definition used for a make order.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkDefinitionName":{
            "maxLength":300,
            "type":"string",
            "description":"Description of a work definition for an item.",
            "nullable":true,
            "readOnly":true,
            "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