Get one alternate resource

get

/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOperation/{WorkDefinitionOperationId}/child/WorkDefinitionOperationResource/{WorkDefinitionOperationResourceId}/child/WorkDefinitionOperationAlternateResource/{WdOperationAlternateResourceId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationAlternateResource-item-response
Type: object
Show Source
  • Title: Units Assigned
    Read Only: true
    Number of resource units the application assigns to perform the operation.
  • Maximum Length: 255
    Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.
  • 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.
  • Read Only: true
    Maximum Length: 512
    Name of the equipment parameter's flat file associated with the work definition operation's alternate resource.
  • 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
  • Title: Priority
    Read Only: true
    Ranking of the alternative resource to use instead of the primary resource.
  • 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.
  • Maximum Length: 255
    Value that uniquely identifies the document item that represents the program file.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the resource.
  • Title: Description
    Read Only: true
    Maximum Length: 240
    Description of the resource.
  • 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.
  • Title: Name
    Read Only: true
    Maximum Length: 80
    Name of the resource.
  • Title: Type
    Read Only: true
    Maximum Length: 30
    Category of the resource. Values include Labor or Equipment.
  • Title: UOM Name
    Read Only: true
    Maximum Length: 25
    Unit of measure that the resource uses.
  • Title: UOM
    Read Only: true
    Maximum Length: 3
    Abbreviation that identifies the unit of measure that the resource uses.
  • Title: Usage
    Read Only: true
    Resource usage that the plant requires to make each unit of the item.
  • 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.
  • 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.
Back to Top