Jump to

• Request
• Response

Get one alternate resource

get

/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionResource/{WorkDefinitionOperationResourceId2}/child/WorkDefinitionOperationAlternateResource/{WdOperationAlternateResourceId}

Request

Path Parameters

• WdOperationAlternateResourceId(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=
• WorkDefinitionId(required): integer(int64)
  Value that uniquely identifies the work definition. It is a primary key that the application generates when it creates the work definition.
• WorkDefinitionOperationResourceId(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:
  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 : workDefinitions-WorkDefinitionResource-WorkDefinitionOperationAlternateResource-item-response

Type: object

Show Source

• AssignedUnits: number
  Title: Units Assigned

  Read Only: true

  Number of resource units the application assigns to perform the operation.
• CurrentRevision: string
  Maximum Length: 255

  Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.
• EquipmentParameterFileContent: string (byte)
  Read Only: true

  Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation alternate resource.
• EquipmentParameterFileName: string
  Read Only: true

  Maximum Length: 512

  Name of the equipment parameter's flat file associated with the work definition operation's alternate resource.
• InverseUsageRate: number
  Title: Inverse Usage

  Read Only: true

  Inverse of the usage rate. The application uses this inverse when the resource usage rate is a fraction, but the inverse of this rate is an integer.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PriorityRanking: number
  Title: Priority

  Read Only: true

  Ranking of the alternative resource to use instead of the primary resource.
• ProgramFileId: integer (int64)
  Read Only: true

  Value that uniquely identifies the document item assigned to the master organization that represents the name of the program file used by the equipment.
• ProgramFileName: string
  Maximum Length: 255

  Value that uniquely identifies the document item that represents the program file.
• ResourceCode: string
  Title: Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the resource.
• ResourceDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  Description of the resource.
• ResourceId: integer (int64)
  Title: Resource

  Read Only: true

  Value that uniquely identifies the production resource. It is a primary key that the application generates when it consumes the production resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  Name of the resource.
• ResourceType: string
  Title: Type

  Read Only: true

  Maximum Length: 30

  Category of the resource. Values include Labor or Equipment.
• UnitOfMeasure: string
  Title: UOM Name

  Read Only: true

  Maximum Length: 25

  Unit of measure that the resource uses.
• UOMCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the resource uses.
• UsageRate: number
  Title: Usage

  Read Only: true

  Resource usage that the plant requires to make each unit of the item.
• WdOperationAlternateResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the alternative resource of a work definition operation. It is a primary key that the application generates when it creates the alternative resource of a work definition operation.
• WdOperationResourceId: integer (int64)
  Read Only: true

  Value that uniquely identifies the resource that the work definition operation consumes. It is a primary key that the application generates when it consumes the resource.

{
    "type":"object",
    "properties":{
        "ResourceCode":{
            "title":"Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InverseUsageRate":{
            "title":"Inverse Usage",
            "type":"number",
            "description":"Inverse of the usage rate. The application uses this inverse when the resource usage rate is a fraction, but the inverse of this rate is an integer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UnitOfMeasure":{
            "title":"UOM Name",
            "maxLength":"25",
            "type":"string",
            "description":"Unit of measure that the resource uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"edit"
            }
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramFileName":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the document item that represents the program file.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"Category of the resource. Values include Labor or Equipment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentRevision":{
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.",
            "nullable":true,
            "x-queryable":true
        },
        "EquipmentParameterFileName":{
            "maxLength":"512",
            "type":"string",
            "description":"Name of the equipment parameter's flat file associated with the work definition operation's alternate resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedUnits":{
            "title":"Units Assigned",
            "type":"number",
            "description":"Number of resource units the application assigns to perform the operation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UsageRate":{
            "title":"Usage",
            "type":"number",
            "description":"Resource usage that the plant requires to make each unit of the item.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PriorityRanking":{
            "title":"Priority",
            "type":"number",
            "description":"Ranking of the alternative resource to use instead of the primary resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource",
            "type":"integer",
            "description":"Value that uniquely identifies the production resource. It is a primary key that the application generates when it consumes the production resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProgramFileId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document item assigned to the master organization that represents the name of the program file used by the equipment.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EquipmentParameterFileContent":{
            "type":"string",
            "description":"Value that uniquely identifies the parametric data and inspection characteristics stored in the equipment parameters flat file associated with the work definition operation alternate resource.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "WdOperationAlternateResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the alternative resource of a work definition operation. It is a primary key that the application generates when it creates the alternative resource of a work definition operation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the resource uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "WdOperationResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that the work definition operation consumes. It is a primary key that the application generates when it consumes the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "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