Jump to

• Request
• Response

GET action not supported

get

/fscmRestApi/resources/11.13.18.05/maintenanceOperationTransactions/{maintenanceOperationTransactionsUniqID}/child/OperationTransactionDetail

Request

Path Parameters

• maintenanceOperationTransactionsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Maintenance Work Order Operation Transactions resource and used to uniquely identify an instance of Maintenance Work Order Operation Transactions. The client should not generate the hash key value. Instead, the client should query on the Maintenance Work Order Operation Transactions collection resource in order to navigate to a specific instance of Maintenance Work Order Operation Transactions 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
• 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
    Finder Variables:
• 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:
  

  • ErrorMessageNames; string; Names of the error messages that occurred when processing the operation transaction. Each error message name corresponds to one text string that the ErrorMessages attribute contains. A comma ( , ) separates each message name.
  • ErrorMessages; string; Text of the error messages that occurred when processing the operation transaction. Each text string for each error message corresponds to one error message name that the ErrorMessageNames attribute contains. A double dollar sign ($$) separated each message.
  • FromDispatchState; string; Value that reflects the state of the operation in the maintenance work order before operation transaction. Valid values for maintenance operation from operation transaction perspective are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.
  • OrganizationCode; string; Abbreviation that identifies the organization where the operation transaction is performed. This organization will be same as the maintenance work order organization.
  • SourceSystemCode; string; Abbreviation that identifies the source application that started this operation transaction. This code must be registered in Oracle Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view.
  • ToDispatchState; string; Value that reflects the to be state of the operation in the maintenance work order post operation transaction. Valid values for maintenance operation are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.
  • TransactionDate; string; Date an time when the operation transaction is performed. The valid date range is from the work order released date till the system date. Future date is not valid and the default value is system date.
  • TransactionNote; string; Text which reflects the details captured during the operation transaction. This is optional to perform the operation transaction.
  • WoOperationSequenceNumber; number; Number that uniquely identifies the operation within the maintenance work orders. An operation transaction is performed against the same in the maintenance work order.
  • WoOperationTransactionId; integer; The value that uniquely identifies the operation transaction performed against the maintenance work order. If the transaction is succesfull the value will be a number, otherwise the value will be 0. This attribute is included in the response payload.
  • WorkOrderNumber; string; Number uniquely identifies the maintenance work order. The operation transaction is performed against the operation within the maintenance work order.
• 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 Top

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.

Body ()

Root Schema : maintenanceOperationTransactions-OperationTransactionDetail

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/maintenanceOperationTransactions-OperationTransactionDetail-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object maintenanceOperationTransactions-OperationTransactionDetail-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/maintenanceOperationTransactions-OperationTransactionDetail-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : maintenanceOperationTransactions-OperationTransactionDetail-item-response

Type: object

Show Source

• ErrorMessageNames: string
  Read Only: true

  Maximum Length: 255

  Names of the error messages that occurred when processing the operation transaction. Each error message name corresponds to one text string that the ErrorMessages attribute contains. A comma ( , ) separates each message name.
• ErrorMessages: string
  Read Only: true

  Maximum Length: 2000

  Text of the error messages that occurred when processing the operation transaction. Each text string for each error message corresponds to one error message name that the ErrorMessageNames attribute contains. A double dollar sign ($$) separated each message.
• FromDispatchState: string
  Title: From Dispatch State

  Maximum Length: 30

  Value that reflects the state of the operation in the maintenance work order before operation transaction. Valid values for maintenance operation from operation transaction perspective are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OperationTransactionDFF: array Flexfields for Operation Transactions
  Title: Flexfields for Operation Transactions

  The Flexfields for Operation Transactions resource manages details about the descriptive flexfields that the maintenance operation transaction uses.
• OrganizationCode: string
  Title: Organization Code

  Maximum Length: 30

  Abbreviation that identifies the organization where the operation transaction is performed. This organization will be same as the maintenance work order organization.
• SourceSystemCode: string
  Title: Source System Code

  Maximum Length: 30

  Abbreviation that identifies the source application that started this operation transaction. This code must be registered in Oracle Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view.
• ToDispatchState: string
  Title: To Dispatch State

  Maximum Length: 30

  Value that reflects the to be state of the operation in the maintenance work order post operation transaction. Valid values for maintenance operation are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.
• TransactionDate: string (date-time)
  Title: Transaction Date

  Date an time when the operation transaction is performed. The valid date range is from the work order released date till the system date. Future date is not valid and the default value is system date.
• TransactionNote: string
  Title: Transaction Note

  Maximum Length: 4000

  Text which reflects the details captured during the operation transaction. This is optional to perform the operation transaction.
• WoOperationSequenceNumber: number
  Title: Operation Sequence

  Number that uniquely identifies the operation within the maintenance work orders. An operation transaction is performed against the same in the maintenance work order.
• WoOperationTransactionId: integer (int64)
  The value that uniquely identifies the operation transaction performed against the maintenance work order. If the transaction is succesfull the value will be a number, otherwise the value will be 0. This attribute is included in the response payload.
• WorkOrderNumber: string
  Title: Work Order

  Maximum Length: 120

  Number uniquely identifies the maintenance work order. The operation transaction is performed against the operation within the maintenance work order.

{
    "type":"object",
    "properties":{
        "WoOperationTransactionId":{
            "type":"integer",
            "description":"The value that uniquely identifies the operation transaction performed against the maintenance work order. If the transaction is succesfull the value will be a number, otherwise the value will be 0. This attribute is included in the response payload.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorMessageNames":{
            "maxLength":255,
            "type":"string",
            "description":"Names of the error messages that occurred when processing the operation transaction. Each error message name corresponds to one text string that the ErrorMessages attribute contains. A comma ( , ) separates each message name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNote":{
            "title":"Transaction Note",
            "maxLength":4000,
            "type":"string",
            "description":"Text which reflects the details captured during the operation transaction. This is optional to perform the operation transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "ToDispatchState":{
            "title":"To Dispatch State",
            "maxLength":30,
            "type":"string",
            "description":"Value that reflects the to be state of the operation in the maintenance work order post operation transaction. Valid values for maintenance operation are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.",
            "nullable":false,
            "x-queryable":true
        },
        "FromDispatchState":{
            "title":"From Dispatch State",
            "maxLength":30,
            "type":"string",
            "description":"Value that reflects the state of the operation in the maintenance work order before operation transaction. Valid values for maintenance operation from operation transaction perspective are READY and COMPLETE. A list of accepted values is defined in the lookup type ORA_WIE_DISPATCH_STATE.",
            "nullable":false,
            "x-queryable":true
        },
        "ErrorMessages":{
            "maxLength":2000,
            "type":"string",
            "description":"Text of the error messages that occurred when processing the operation transaction. Each text string for each error message corresponds to one error message name that the ErrorMessageNames attribute contains. A double dollar sign ($$) separated each message.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":120,
            "type":"string",
            "description":"Number uniquely identifies the maintenance work order. The operation transaction is performed against the operation within the maintenance work order.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationTransactionDFF":{
            "title":"Flexfields for Operation Transactions",
            "type":"array",
            "description":"The Flexfields for Operation Transactions resource manages details about the descriptive flexfields that the maintenance operation transaction uses.",
            "items":{
                "$ref":"#/components/schemas/maintenanceOperationTransactions-OperationTransactionDetail-OperationTransactionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the organization where the operation transaction is performed. This organization will be same as the maintenance work order organization.",
            "nullable":true,
            "x-queryable":true
        },
        "WoOperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"Number that uniquely identifies the operation within the maintenance work orders. An operation transaction is performed against the same in the maintenance work order.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceSystemCode":{
            "title":"Source System Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the source application that started this operation transaction. This code must be registered in Oracle Manufacturing Cloud. The application validates this value against the WIE_SOURCE_SYSTEMS_V database view.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"Date an time when the operation transaction is performed. The valid date range is from the work order released date till the system date. Future date is not valid and the default value is system date.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Flexfields for Operation Transactions

Type: array

Title: Flexfields for Operation Transactions

The Flexfields for Operation Transactions resource manages details about the descriptive flexfields that the maintenance operation transaction uses.

Show Source

• Array of: object maintenanceOperationTransactions-OperationTransactionDetail-OperationTransactionDFF-item-response

{
    "title":"Flexfields for Operation Transactions",
    "type":"array",
    "description":"The Flexfields for Operation Transactions resource manages details about the descriptive flexfields that the maintenance operation transaction uses.",
    "items":{
        "$ref":"#/components/schemas/maintenanceOperationTransactions-OperationTransactionDetail-OperationTransactionDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : maintenanceOperationTransactions-OperationTransactionDetail-OperationTransactionDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 80

  Descriptive flexfield context name for operation transactions.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• Discriminator: string
• InterfaceRowId: integer (int64)
  Value that uniquely identifies the operation transaction detail that references a descriptive flexfield. It is recommended that you not include this attribute in the request payload. The response payload contains the primary key of the operation transaction detail that references the descriptive flexfield.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "InterfaceRowId":{
            "type":"integer",
            "description":"Value that uniquely identifies the operation transaction detail that references a descriptive flexfield. It is recommended that you not include this attribute in the request payload. The response payload contains the primary key of the operation transaction detail that references the descriptive flexfield.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "Discriminator":{
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":80,
            "type":"string",
            "description":"Descriptive flexfield context name for operation transactions.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top