Get all alternate resources
get
/fscmRestApi/resources/11.13.18.05/workDefinitions/{WorkDefinitionId}/child/WorkDefinitionOperation/{WorkDefinitionOperationId}/child/WorkDefinitionOperationResource/{WorkDefinitionOperationResourceId}/child/WorkDefinitionOperationAlternateResource
Request
Path Parameters
-
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.
-
WorkDefinitionOperationId(required): integer(int64)
Value that uniquely identifies the work definition operation. It is a primary key that the application generates when it creates the work definition operation.
-
WorkDefinitionOperationResourceId(required): integer(int64)
Value that uniquely identifies the resource for the work definition operation. It is a primary key that the application generates when it creates the resource.
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 alternate resources for a work definition operation according to the alternate resource identifier as the primary key.
Finder Variables:- WdOperationAlternateResourceId; integer; Value that uniquely identifies the alternate resource for the work definition operation. It is a primary key that the application generates when it creates the resource. This attribute is required.
- PrimaryKey: Finds alternate resources for a work definition operation according to the alternate resource identifier as the primary key.
-
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:- CurrentRevision; string; Value that uniquely identifies the current revision of the document item, which represents the current revision of the program file.
- EquipmentParameterFileName; string; Name of the equipment parameter's flat file associated with the work definition operation's alternate resource.
- PriorityRanking; number; Ranking of the alternative resource to use instead of the primary resource.
- ProgramFileId; integer; 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; Value that uniquely identifies the document item that represents the program file.
- ResourceCode; string; Abbreviation that identifies the resource.
- ResourceId; integer; Value that uniquely identifies the production resource. It is a primary key that the application generates when it consumes the production resource.
- ResourceType; string; Category of the resource. Values include Labor or Equipment.
- UsageRate; number; Resource usage that the plant requires to make each unit of the item.
- WdOperationAlternateResourceId; integer; 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; 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.
-
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:
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 TopResponse
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.
Root Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationAlternateResource
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : workDefinitions-WorkDefinitionOperation-WorkDefinitionOperationResource-WorkDefinitionOperationAlternateResource-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.