Get one resource
get
/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/ProcessWorkOrderResource/{ProcessWorkOrderResourceUniqID}
Request
Path Parameters
-
ProcessWorkOrderResourceUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Work Order Resources resource and used to uniquely identify an instance of Work Order Resources. The client should not generate the hash key value. Instead, the client should query on the Work Order Resources collection resource in order to navigate to a specific instance of Work Order Resources to get the hash key.
-
processWorkOrdersUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Process Work Orders resource and used to uniquely identify an instance of Process Work Orders. The client should not generate the hash key value. Instead, the client should query on the Process Work Orders collection resource in order to navigate to a specific instance of Process Work Orders to get the hash key.
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 : processWorkOrders-ProcessWorkOrderResource-item-response
Type:
Show Source
object
-
ActualResourceUsage: number
Title:
Actual Resource Usage
Read Only:true
Net actual usage of the assigned resource. -
AssignedUnits: number
Title:
Assigned Units
Default Value:1
Number of resource units required to perform the operation. -
BasisType: string
Title:
Basis
Maximum Length:30
Default Value:1
Value that indicates whether the resource quantity is fixed; for example, usage per lot produced, or variable; for example, usage per item produced. A list of accepted values is defined in the lookup type EGP_BOM_BASIS_TYPE. -
ChargeType: string
Title:
Charge Type
Maximum Length:30
Value that indicates whether resource transactions are automatically generated and at what stage. A list of accepted values is defined in the lookup type ORA_WIS_CHARGE_TYPE. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the process work order operation resource. -
CreationDate: string
(date-time)
Read Only:
true
Date when the used created the work order operation resource. -
EquipmentProfileCode: string
Maximum Length:
255
Abbreviation that identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in. -
EquipmentProfileId: integer
(int64)
Title:
Equipment Profile
Value that uniquely identifies the equipment profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the user most recently updated the work order operation resource. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who updated the process work order resource. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the operation that processes the resource. -
OperationSequenceNumber: number
Title:
Operation Sequence
Read Only:true
Number that indicates the sequence to use when performing the work order operations. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization. -
PhantomFlag: boolean
Read Only:
true
Maximum Length:1
Default Value:false
Contains one of the following values: true or false. If true, then the resource associated with this operation is pulled in as part of a phantom explosion that pulled in the resources from the work definition of a phantom material tied to the operation. If false, then the resource is not a part of phantom explosion. The default value is false. -
PlannedCompletionDate: string
(date-time)
Title:
Completion Date
Planned date and time till the resource is engaged for the operation. The scheduling application sets this date. The planned completion date must not occur before the operation start date or after the operation finish date. This attribute is required. -
PlannedStartDate: string
(date-time)
Title:
Start Date
Planned date and time to engage the resource for the operation. The scheduling application sets this date. The planned start date must not occur before the operation start date or after the operation finish date. This attribute is required. -
PrincipalFlag: boolean
Title:
Principal
Maximum Length:1
Contains one of the following values: true or false. If true, then this resource is the principal resource among the group of simultaneous resources for that operation sequence. If false, then this resource is not the principal resource. This attribute does not have a default value. -
ProfileCode: string
Maximum Length:
255
Abbreviation that identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in. -
ProfileId: integer
(int64)
Value that uniquely identifies the job profile associated with the work order operation resource. This attribute is associated with a feature that requires opt in.
-
RequiredUsage: number
Title:
Required Usage
Resource usage that the plant requires to make the work order quantity. The application calculates this value depending on whether the basis type is fixed or variable. Fixed: the required usage equals the usage rate. Variable: the required usage equals the usage rate multiplied by the work order quantity. -
ResourceActivityCode: string
Title:
Activity
Maximum Length:30
Abbreviation that identifies the resource activity. -
ResourceAttachment: array
Resource Attachments
Title:
Resource Attachments
The Resource Attachments resource manages the attachments for a resource. -
ResourceCode: string
Title:
Code
Maximum Length:30
Abbreviation that identifies the resource. -
ResourceDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the resource. -
ResourceDFF: array
Flexfields for Resources
Title:
Flexfields for Resources
The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use. -
ResourceExceptionCount: array
Exceptions for Operation Resources
Title:
Exceptions for Operation Resources
The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation. -
ResourceId: integer
(int64)
Value that uniquely identifies the resource. It's a primary key that the application generates when it creates the resource.
-
ResourceInstance: array
Resource Instances
Title:
Resource Instances
The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the resource. -
ResourceSequenceNumber: number
Title:
Sequence
Number that the application uses to determine the step in the sequence it must use to make sure resources work together correctly to finish the operation. If multiple resource lines include the same resource sequence number, then the application schedules them to occur at the same time. -
ResourceType: string
Title:
Type
Read Only:true
Maximum Length:30
Type of the resource. Values include Labor or Equipment. -
ScheduledIndicator: string
Title:
Scheduled
Maximum Length:30
Contains one of the following values: true or false. If true, then scheduling schedules the resource and computes the start date and completion date. If false, then scheduling does not schedule the resource and sets the start date equal to the completion date. The default value is true. -
StandardOperationCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the standard operation. -
StandardOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the standard operation of a work order. It's a primary key that the application generates when it creates the operation. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Unit of measure that the resource uses. -
UOMCode: string
Read Only:
true
Maximum Length:3
Abbreviation that identifies the unit of measure that the resource uses. -
WorkAreaCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work area. -
WorkAreaDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work area. -
WorkAreaId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work area. It's a primary key that the application generates when it creates the work area. -
WorkAreaName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work area. -
WorkCenterCode: string
Title:
Code
Read Only:true
Maximum Length:30
Abbreviation that identifies the work center. -
WorkCenterDescription: string
Title:
Description
Read Only:true
Maximum Length:240
Description of the work center. -
WorkCenterId: integer
(int64)
Value that uniquely identifies the work center. It's a primary key that the application generates when it creates the work center.
-
WorkCenterName: string
Title:
Name
Read Only:true
Maximum Length:80
Name of the work center. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order. -
WorkOrderOperationId: integer
(int64)
Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation.
-
WorkOrderOperationResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource for the work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Resource Attachments
Type:
array
Title:
Resource Attachments
The Resource Attachments resource manages the attachments for a resource.
Show Source
Nested Schema : Flexfields for Resources
Type:
array
Title:
Flexfields for Resources
The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use.
Show Source
Nested Schema : Exceptions for Operation Resources
Type:
array
Title:
Exceptions for Operation Resources
The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation.
Show Source
Nested Schema : Resource Instances
Type:
array
Title:
Resource Instances
The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource.
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.
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceAttachment-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
An identifier used for tracking the uploaded files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
Value that uniquely identifies the attachment of a work order operation material. It's a primary key that the application generates when a document is attached to the work order operation material. -
CategoryName: string
Title:
Category
Maximum Length:30
Name of the category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
User who created the attachment. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
Login that the user used when creating the attachment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the user created the attachment record. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
Abbreviation that identifies the data type. -
Description: string
Title:
Description
Maximum Length:255
Description of the attachment. -
DmDocumentId: string
Maximum Length:
255
Value that uniquely identifies the attachment. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
Folder path of the attachment. -
DmVersionNumber: string
Maximum Length:
255
Number that identifies the current version of the attachment. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
Abbreviation that identifies the error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
Text of the error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
Date when the contents of the attachment expire. -
FileContents: string
(byte)
Title:
File Contents
Contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
File name of the attachment. -
FileUrl: string
Title:
File Url
URL (Uniform Resource Locator) of the attachment. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date and time when the user most recently updated the document that's attached to the work order. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
Login of the user who most recently updated the document that's attached to the work order. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
Login that the user used when updating the document that's attached to the work order. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
Title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
Content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
Length of the attached file. -
UploadedFileName: string
Title:
Uploaded File Name
Name of the attached file. -
UploadedText: string
Title:
Uploaded Text
Text of the attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
URI (Uniform Resource Identifier) that identifies the attachment. -
Url: string
Title:
Url
Maximum Length:4000
URL (Uniform Resource Locator) that locates the attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
Login that the user used when adding or modifying the attachment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work order operation resources. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WoOperationResourceId: integer
(int64)
Value that uniquely identifies a resource of a work order operation. It's a primary key that the application generates when it creates the work order operation resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceExceptionCount-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceId: integer
(int64)
Read Only:
true
Value that uniquely identifies the resource for the work order operation. It's a primary key that the application generates when it creates the resource for the work order operation. -
WorkOrderOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation. -
WorkOrderResourceExceptionCount: integer
Read Only:
true
Count of the open exceptions of the Resource type for this work order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceInstance-item-response
Type:
Show Source
object
-
ChargedQuantity: number
Title:
Actual Usage
Read Only:true
Actual usage of the resource instance. -
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. -
EquipmentInstanceCode: string
Title:
Identifier
Maximum Length:80
Abbreviation that identifies the equipment resource instance. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the equipment resource instance. It's a primary key that the application generates when it creates a equipment instance.
-
EquipmentInstanceName: string
Title:
Name
Read Only:true
Maximum Length:120
Name of the equipment resource instance. -
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 resource instance of the work order operation. -
EquipmentParameterFileName: string
Read Only:
true
Maximum Length:512
Name of the equipment parameters flat file associated with the resource instance of the work order operation. -
LaborInstanceCode: string
Title:
Identifier
Maximum Length:30
Abbreviation that identifies the labor resource instance. -
LaborInstanceId: integer
(int64)
Value that uniquely identifies the labor resource instance. It's a primary key that the application generates when it creates a labor instance.
-
LaborInstanceName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the labor resource instance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the inventory organization that's enabled for manufacturing. It's a primary key of the inventory organization. -
ProgramFileId: integer
(int64)
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:
300
Name of the program file associated with the automation equipment resource and used by the work order resource instance. -
ResourceInstanceDFF: array
Flexfields for Resource Instances
Title:
Flexfields for Resource Instances
The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance. -
ResourceType: string
Read Only:
true
Maximum Length:255
Type of the resource. Values include Labor or Equipment. -
WorkOrderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order. It's a primary key that the application generates when it creates the work order. -
WorkOrderOperationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the work order operation. It's a primary key that the application generates when it creates the work order operation. -
WorkOrderOperationResourceId: integer
(int64)
Value that uniquely identifies the resource of a work order operation. It's a primary key that the application generates when it creates the resource for the work order operation.
-
WorkOrderOperationResourceInstanceId: integer
(int64)
Value that uniquely identifies the resource instance of a work order operation resource. It's a primary key that the application generates when it creates the resource instance for the work order operation resource.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Resource Instances
Type:
array
Title:
Flexfields for Resource Instances
The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance.
Show Source
Nested Schema : processWorkOrders-ProcessWorkOrderResource-ResourceInstance-ResourceInstanceDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context name for work order operation resource instance. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for work order operation resource instance. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
WoOpResourceInstanceId: integer
(int64)
Value that uniquely identifies an output of a work order operation resource instance. It's a primary key that the application generates when it creates the work order operation resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ResourceAttachment
-
Parameters:
- ProcessWorkOrderResourceUniqID:
$request.path.ProcessWorkOrderResourceUniqID
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Resource Attachments resource manages the attachments for a resource. - ProcessWorkOrderResourceUniqID:
- ResourceDFF
-
Parameters:
- ProcessWorkOrderResourceUniqID:
$request.path.ProcessWorkOrderResourceUniqID
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Flexfields for Resources resource manages descriptive flexfields that contain details about the resources that the work order operations use. - ProcessWorkOrderResourceUniqID:
- ResourceExceptionCount
-
Parameters:
- ProcessWorkOrderResourceUniqID:
$request.path.ProcessWorkOrderResourceUniqID
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Exceptions for Operation Resources resource gets the count of exceptions that occurred for a resource during the operation. - ProcessWorkOrderResourceUniqID:
- ResourceInstance
-
Parameters:
- ProcessWorkOrderResourceUniqID:
$request.path.ProcessWorkOrderResourceUniqID
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Resource Instances resource manages the instances of a work order operation. Each instance supports an equipment resource or labor resource. - ProcessWorkOrderResourceUniqID: