Create transactions
post
/fscmRestApi/resources/11.13.18.05/maintenanceResourceTransactions
Request
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ResourceTransactionDetail: array
Details
Title:
Details
The resource Transaction Details for Maintenance Resources stores details about the resource charges for the work order. -
SourceSystemCode: string
Title:
Source System Code
Maximum Length:30
Abbreviation that identifies the type of source system that starts the operation transaction. Values include internal or external. -
SourceSystemType: string
Title:
Source System Type
Maximum Length:30
Default Value:EXTERNAL
Type of source system that starts the operation transaction. You must register this value in Oracle Fusion Manufacturing Cloud. The application validates the value against the WIE_SOURCE_SYSTEMS_V database view.
Nested Schema : Details
Type:
array
Title:
Details
The resource Transaction Details for Maintenance Resources stores details about the resource charges for the work order.
Show Source
Nested Schema : maintenanceResourceTransactions-ResourceTransactionDetail-item-post-request
Type:
Show Source
object
-
EquipmentInstanceCode: string
Maximum Length:
255
Abbreviation that uniquely identifies the equipment resource in the manufacturing plant. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the resource of equipment type.
-
EquipmentInstanceIdentifier: string
Title:
Equipment Identifier
Maximum Length:80
Value that uniquely identifies the equipment resource in the manufacturing plant. -
LaborInstanceCode: string
Maximum Length:
255
Abbreviation that uniquely identifies the labor resource in the manufacturing plant. -
LaborInstanceId: integer
(int64)
Value that uniquely identifies the resource of labor type.
-
LaborInstanceIdentifier: string
Title:
Labor Identifier
Maximum Length:30
Value that uniquely identifies the labor resource in the manufacturing plant. -
OperationSequenceNumber: number
Title:
Operation Sequence
Number that uniquely identifies the operation in each maintenance work.order. The application transacts each resource for an operation in the maintenance work order. -
OrganizationCode: string
Title:
Organization Code
Maximum Length:30
Abbreviation that identifies the organization where the application performs the resource transaction. This organization is the same as the organization for the maintenance work order. -
ReasonForRepairCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the reason for repair from the condition event. -
RepairTransactionCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the repair transaction from the condition event. -
ResourceActivityCode: string
Title:
Resource Activity Code
Maximum Length:30
Abbreviation that identifies the activity that the application performed for an operation in the maintenance work order. This attribute is optional for the resource transaction. Lookup ORA_WIS_RESOURCE_ACTIVITY defines the following predefined values that you can use: Run, Teardown, or Setup. You can modify these values. -
ResourceCode: string
Title:
Resource Code
Maximum Length:30
Abbreviation that uniquely identifies the resource that the application used for an operation in the maintenance work order. -
ResourceSequenceNumber: number
Title:
Resource Sequence
Number that identifies the resource in the operation for the maintenance work order. The application can use the same resource sequence number for more than one resource, and can simultaneously call these resources. If the application simultaneously calls them, then you must specify one of the resources as the principal resource. If scheduled equals YES for the principal resource, then scheduled can equal YES or NO for the other resources. If scheduled equals NO for the principal resource, then scheduled must equal NO for the other resources. -
ResourceTransactionDFF: array
Descriptive Flexfields
Title:
Descriptive Flexfields
The resource Flexfields for Transactions for Maintenance Resources gets details from flexfields that store information about the transaction. -
SourceHeaderReference: string
Title:
Source Header Reference
Maximum Length:240
Reference to the object header in the source system. -
SourceHeaderReferenceId: integer
(int64)
Title:
Source Header Reference ID
Value that uniquely identifies the object header in the source system. -
SourceLineReference: string
Title:
Source Line Reference
Maximum Length:240
Reference to the object line in the source system. -
SourceLineReferenceId: integer
(int64)
Title:
Source Line Reference ID
Value that uniquely identifies the object line in the source system. -
SourceSystemCode: string
Title:
Source System Code
Maximum Length:30
Abbreviation that identifies the source system that started this operation transaction. You must register this code in Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view. -
TransactionDate: string
(date-time)
Title:
Transaction Date
Date and time when the application performed the transaction for the resource. You can use dates starting with the release date for the work order up to the current system date. You cannot use a date that occurs after the current system date. The current system date is the default value. -
TransactionQuantity(required): number
Title:
Transaction Quantity
Quantity of the resource charged or reversed against the maintenance work order. -
TransactionTypeCode(required): string
Title:
Transaction Type Code
Maximum Length:30
Contains one of the following values. RESOURCE_CHARGE: charge the resource against the operation for the maintenance work order. RESOURCE_REVERSE: reverse the charges of the resource against the operation for the maintenance work order. This attribute is required for the resource transaction. Lookup ORA_WIE_TRANSACTION_TYPES defines the values that you can use. -
WorkAccomplishedCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the work accomplished from the condition event. -
WorkOrderNumber: string
Title:
Work Order
Maximum Length:120
Number that uniquely identifies the maintenance work order. The application performs the resource transaction for this maintenance work order.
Nested Schema : Descriptive Flexfields
Type:
array
Title:
Descriptive Flexfields
The resource Flexfields for Transactions for Maintenance Resources gets details from flexfields that store information about the transaction.
Show Source
Nested Schema : maintenanceResourceTransactions-ResourceTransactionDetail-ResourceTransactionDFF-item-post-request
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context of the resource transaction. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Discriminator: string
This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
-
InterfaceRowId: integer
(int64)
Primary key of the ResourceTransactionDetail record that references a descriptive flefield. It is recommended that you not include this attribute in the request payload. The response payload contains the primary key of the ResourceTransactionDetail that references the descriptive flefield.
Response
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 : maintenanceResourceTransactions-item-response
Type:
Show Source
object
-
ErrorsExistFlag: boolean
Read Only:
true
Contains one of the following values: true or false. If true, then an error occurred while processing the operation transaction. If false, then an error did not occur. The response payload includes this attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResourceTransactionDetail: array
Details
Title:
Details
The resource Transaction Details for Maintenance Resources stores details about the resource charges for the work order. -
SourceSystemCode: string
Title:
Source System Code
Maximum Length:30
Abbreviation that identifies the type of source system that starts the operation transaction. Values include internal or external. -
SourceSystemType: string
Title:
Source System Type
Maximum Length:30
Default Value:EXTERNAL
Type of source system that starts the operation transaction. You must register this value in Oracle Fusion Manufacturing Cloud. The application validates the value against the WIE_SOURCE_SYSTEMS_V database view.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Details
Type:
array
Title:
Details
The resource Transaction Details for Maintenance Resources stores details about the resource charges for the work order.
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 : maintenanceResourceTransactions-ResourceTransactionDetail-item-response
Type:
Show Source
object
-
EquipmentInstanceCode: string
Maximum Length:
255
Abbreviation that uniquely identifies the equipment resource in the manufacturing plant. -
EquipmentInstanceId: integer
(int64)
Value that uniquely identifies the resource of equipment type.
-
EquipmentInstanceIdentifier: string
Title:
Equipment Identifier
Maximum Length:80
Value that uniquely identifies the equipment resource in the manufacturing plant. -
ErrorMessageNames: string
Read Only:
true
Maximum Length:255
Names of the error messages that occurred when processing the item transaction. Each error message name corresponds to one text string that the ErrorMessages attribute contains. A comma ( , ) separate each message name. -
ErrorMessages: string
Read Only:
true
Maximum Length:2000
Text of the error messages that occurred when processing the item transaction. Each text string for each error message corresponds to one error message name that the ErrorMessageNames attribute contains. Double dollar signs ($$) separate each message. -
LaborInstanceCode: string
Maximum Length:
255
Abbreviation that uniquely identifies the labor resource in the manufacturing plant. -
LaborInstanceId: integer
(int64)
Value that uniquely identifies the resource of labor type.
-
LaborInstanceIdentifier: string
Title:
Labor Identifier
Maximum Length:30
Value that uniquely identifies the labor resource in the manufacturing plant. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OperationSequenceNumber: number
Title:
Operation Sequence
Number that uniquely identifies the operation in each maintenance work.order. The application transacts each resource for an operation in the maintenance work order. -
OrganizationCode: string
Title:
Organization Code
Maximum Length:30
Abbreviation that identifies the organization where the application performs the resource transaction. This organization is the same as the organization for the maintenance work order. -
ReasonForRepairCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the reason for repair from the condition event. -
RepairTransactionCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the repair transaction from the condition event. -
ResourceActivityCode: string
Title:
Resource Activity Code
Maximum Length:30
Abbreviation that identifies the activity that the application performed for an operation in the maintenance work order. This attribute is optional for the resource transaction. Lookup ORA_WIS_RESOURCE_ACTIVITY defines the following predefined values that you can use: Run, Teardown, or Setup. You can modify these values. -
ResourceCode: string
Title:
Resource Code
Maximum Length:30
Abbreviation that uniquely identifies the resource that the application used for an operation in the maintenance work order. -
ResourceSequenceNumber: number
Title:
Resource Sequence
Number that identifies the resource in the operation for the maintenance work order. The application can use the same resource sequence number for more than one resource, and can simultaneously call these resources. If the application simultaneously calls them, then you must specify one of the resources as the principal resource. If scheduled equals YES for the principal resource, then scheduled can equal YES or NO for the other resources. If scheduled equals NO for the principal resource, then scheduled must equal NO for the other resources. -
ResourceTransactionDFF: array
Descriptive Flexfields
Title:
Descriptive Flexfields
The resource Flexfields for Transactions for Maintenance Resources gets details from flexfields that store information about the transaction. -
SourceHeaderReference: string
Title:
Source Header Reference
Maximum Length:240
Reference to the object header in the source system. -
SourceHeaderReferenceId: integer
(int64)
Title:
Source Header Reference ID
Value that uniquely identifies the object header in the source system. -
SourceLineReference: string
Title:
Source Line Reference
Maximum Length:240
Reference to the object line in the source system. -
SourceLineReferenceId: integer
(int64)
Title:
Source Line Reference ID
Value that uniquely identifies the object line in the source system. -
SourceSystemCode: string
Title:
Source System Code
Maximum Length:30
Abbreviation that identifies the source system that started this operation transaction. You must register this code in Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view. -
TransactionDate: string
(date-time)
Title:
Transaction Date
Date and time when the application performed the transaction for the resource. You can use dates starting with the release date for the work order up to the current system date. You cannot use a date that occurs after the current system date. The current system date is the default value. -
TransactionQuantity: number
Title:
Transaction Quantity
Quantity of the resource charged or reversed against the maintenance work order. -
TransactionTypeCode: string
Title:
Transaction Type Code
Maximum Length:30
Contains one of the following values. RESOURCE_CHARGE: charge the resource against the operation for the maintenance work order. RESOURCE_REVERSE: reverse the charges of the resource against the operation for the maintenance work order. This attribute is required for the resource transaction. Lookup ORA_WIE_TRANSACTION_TYPES defines the values that you can use. -
WoResourceTransactionId: integer
Read Only:
true
Value that uniquely identifies the resource transaction that the application performed for the maintenance work order. If the transaction successfully finishes, then WoResourceTransactionId contains the number that identifiies this transaction. If the transaction does not successfully finish, then WoResourceTransactionId contains 0 (zero), the ErrorsExistFlag attribute contains true, and the ErrorMessages and ErrorMessageNames attributes contain error details. The response payload includes this attribute. -
WorkAccomplishedCode: string
Maximum Length:
30
Abbreviation that uniquely identifies the work accomplished from the condition event. -
WorkOrderNumber: string
Title:
Work Order
Maximum Length:120
Number that uniquely identifies the maintenance work order. The application performs the resource transaction for this maintenance work order.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Descriptive Flexfields
Type:
array
Title:
Descriptive Flexfields
The resource Flexfields for Transactions for Maintenance Resources gets details from flexfields that store information about the transaction.
Show Source
Nested Schema : maintenanceResourceTransactions-ResourceTransactionDetail-ResourceTransactionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:80
Descriptive flexfield context of the resource transaction. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
Discriminator: string
This is a transient attribute. The value of this attribute will always be null. Ignore this attribute.
-
InterfaceRowId: integer
(int64)
Primary key of the ResourceTransactionDetail record that references a descriptive flefield. It is recommended that you not include this attribute in the request payload. The response payload contains the primary key of the ResourceTransactionDetail that references the descriptive flefield.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ResourceTransactionDetail
-
Parameters:
- maintenanceResourceTransactionsUniqID:
$request.path.maintenanceResourceTransactionsUniqID
The resource Transaction Details for Maintenance Resources stores details about the resource charges for the work order. - maintenanceResourceTransactionsUniqID:
Examples
This example describes how to create one maintenance resource transaction.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/maintenanceResourceTransactions"
Example Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.
{ "SourceSystemType":"EXTERNAL", "SourceSystemCode":"SAP", "ResourceTransactionDetail":[{ "ResourceCode":"Engr1", "OperationSequenceNumber":10, "TransactionDate" : "2017-08-28 01:56:49", "OrganizationCode":"M1", "TransactionTypeCode":"RESOURCE_CHARGE", "TransactionQuantity": 1, "WorkOrderNumber":"M1-1089", "ResourceSequenceNumber":10 }] }
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "SourceSystemType" : "EXTERNAL", "SourceSystemCode" : "SAP", "ErrorsExistFlag" : "false", "ResourceTransactionDetail" : [ { "WoResourceTransactionId" : 9823, "SourceSystemCode" : null, "OrganizationCode" : "M1", "WorkOrderNumber" : "M1-1089", "OperationSequenceNumber" : 10, "ResourceSequenceNumber" : 10, "ResourceCode" : "Engr1", "ResourceActivityCode" : null, "TransactionTypeCode" : "RESOURCE_CHARGE", "TransactionQuantity" : 1, "TransactionDate" : "2017-08-27T18:56:49-07:00", "SourceLineReference" : null, "SourceHeaderReference" : null, "SourceLineReferenceId" : null, "SourceHeaderReferenceId" : null, "ErrorMessages" : "", "ErrorMessageNames" : "", "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/maintenanceResourceTransactions/300100093101744/child/ResourceTransactionDetail/300100093101745", "name" : "ResourceTransactionDetail", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/maintenanceResourceTransactions/300100093101744/child/ResourceTransactionDetail/300100093101745", "name" : "ResourceTransactionDetail", "kind" : "item" }, { "rel" : "parent", "href" : "https://servername/fscmRestApi/resources/version/maintenanceResourceTransactions/300100093101744", "name" : "maintenanceResourceTransactions", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/maintenanceResourceTransactions/300100093101744/child/ResourceTransactionDetail/300100093101745/child/ResourceTransactionDFF", "name" : "ResourceTransactionDFF", "kind" : "collection" } ] } ], "links" : [ { "rel" : "self", "href" : "https://servername/fscmRestApi/resources/version/maintenanceResourceTransactions/300100093101744", "name" : "maintenanceResourceTransactions", "kind" : "item", "properties" : { "changeIndicator" : "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel" : "canonical", "href" : "https://servername/fscmRestApi/resources/version/maintenanceResourceTransactions/300100093101744", "name" : "maintenanceResourceTransactions", "kind" : "item" }, { "rel" : "child", "href" : "https://servername/fscmRestApi/resources/version/maintenanceResourceTransactions/300100093101744/child/ResourceTransactionDetail", "name" : "ResourceTransactionDetail", "kind" : "collection" } ] }