Get one resource
get
/fscmRestApi/resources/11.13.18.05/standardOperations/{StandardOperationId}/child/StandardOperationResource/{StandardOperationResourceId}/child/StandardOperationAlternateResource/{StandardOperationAlternateResourceId}
Request
Path Parameters
-
StandardOperationAlternateResourceId(required): integer(int64)
Value that uniquely identifies the alternative resource of a standard operation. It is a primary key that the application generates when it creates the alternative resource.
-
StandardOperationId(required): integer(int64)
Value that uniquely identifies the standard operation. It is a primary key that the application generates when it creates the standard operation.
-
StandardOperationResourceId(required): integer(int64)
Value that uniquely identifies the standard operation resource. 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 -
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 TopResponse
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.
Root Schema : standardOperations-StandardOperationResource-StandardOperationAlternateResource-item-response
Type:
Show Source
object
-
AssignedUnits: number
Title:
Units Assigned
Number of resource units the application assigns to perform the operation for the alternative resource. -
CostedFlag: boolean
Title:
Costing enabled
Read Only:true
Maximum Length:1
Contains one of the following values: true or false. If true, then consider resource costs when costing the work order. If false, then do not consider these costs. The default value is false. -
InverseUsageRate: number
Title:
Inverse Usage
Resource usage that the plant uses to make each unit of the item for the alternative resource. This value is the inverse of the usage rate. The application uses this inverse value when the usage rate for the alternative resource 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: integer
Priority ranking of the alternative resource to use in place of the primary resource.
-
ResourceCode: string
Title:
Alternate Resources
Maximum Length:30
Abbreviation that identifies the alternative resource. -
ResourceDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the alternative resource. -
ResourceId: integer
(int64)
Value that uniquely identifies the alternative resource. It is a primary key that the application generates when it creates the alternative resource.
-
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the alternative resource. -
ResourceType: string
Title:
Type
Read Only:true
Maximum Length:30
Category of the alternative resource. Values include Labor or Equipment. -
StandardOperationAlternateResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the alternative resource of a standard operation. It is a primary key that the application generates when it creates the alternative resource. -
StandardOperationResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource that the standard operation uses. It is a primary key that the application generates when it creates the resource. -
UnitOfMeasure: string
Read Only:
true
Maximum Length:255
Unit of measure that the alternate resource uses. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure that the alternate resource uses. -
UsageRate: number
Title:
Usage
Resource usage that the plant requires to make each unit of the item for the alternative 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.