Create resource instances
post
/fscmRestApi/resources/11.13.18.05/processWorkOrders/{processWorkOrdersUniqID}/child/Operation/{WorkOrderOperationId}/child/Resource/{ResourceUniqID}/child/ResourceInstance
Request
Path Parameters
-
ResourceUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Resources resource and used to uniquely identify an instance of Resources. The client should not generate the hash key value. Instead, the client should query on the Resources collection resource in order to navigate to a specific instance of Resources to get the hash key.
-
WorkOrderOperationId(required): 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.
-
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.
Header Parameters
-
Metadata-Context: string
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: string
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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.
-
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.
-
PersonId: integer
(int64)
Value that uniquely identifies a person in Human Capital Management.
-
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. -
WorkOrderOperationResourceId(required): 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 : 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-Operation-Resource-ResourceInstance-ResourceInstanceDFF-item-post-request
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. -
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.
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.
Root Schema : processWorkOrders-Operation-Resource-ResourceInstance-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Read Only:
true
Identifier of the asset associated with the resource instance. -
AssetItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the asset item. -
AssetNumber: string
Read Only:
true
Maximum Length:80
Number of the assets associated with the resource instance. -
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. -
Description: string
Read Only:
true
Maximum Length:240
Description of the resource instance. -
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. -
InventoryItemId: integer
(int64)
Title:
Item Number
Read Only:true
Identifier of the inventory item for the resource instance. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Item number of the resource instance. -
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. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
Identifier of the resource instance. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
Name of the resource instance. -
PartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
Number that identifies the resource instance. -
PartyType: string
Title:
Type
Read Only:true
Maximum Length:30
Type of the resource instance. -
PartyUsageCode: string
Title:
Usage
Read Only:true
Maximum Length:30
Code of party usage assigned to the party. -
PartyUsageMeaning: string
Read Only:
true
Maximum Length:255
Meaning of the party usage assigned to the party. -
PartyUsgAssignmentId: integer
(int64)
Read Only:
true
Unique identifier for a party usage assignment. -
PersonId: integer
(int64)
Value that uniquely identifies a person in Human Capital Management.
-
PersonName: string
Read Only:
true
Maximum Length:255
Name of a Worker in Human capital management. -
PersonNumber: string
Read Only:
true
Maximum Length:255
Number that is assigned to each person in Human Capital Management. -
PrimaryPhoneNumber: string
Title:
Primary Phone
Read Only:true
Maximum Length:40
Primary phone number of the resource instance. -
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 : 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-Operation-Resource-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
- ResourceInstanceDFF
-
Parameters:
- ResourceUniqID:
$request.path.ResourceUniqID
- WorkOrderOperationId:
$request.path.WorkOrderOperationId
- WorkOrderOperationResourceInstanceId:
$request.path.WorkOrderOperationResourceInstanceId
- processWorkOrdersUniqID:
$request.path.processWorkOrdersUniqID
The Flexfields for Resource Instances resource manages descriptive flexfields that contain details about the resource instance. - ResourceUniqID: