Jump to

• Request
• Response
• Examples

Create flexfields

post

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

Request

Path Parameters

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

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "__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"
                }
            }
        },
        "Discriminator":{
            "type":"string",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "__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"
                }
            }
        }
    }
}

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-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"
    }
}

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."
        }
    }
}

Links

LVVO_V___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D10493%2CBind_DescriptiveFlexfieldCode%3DWIE_OPERATION_TRANSACTIONS

The following properties are defined on the LOV link relation:

• Source Attribute: __FLEX_Context_DisplayValue; Target Attribute: Name
• Display Attribute: Name, Description

LVVO___FLEX_Context

Operation: /fscmRestApi/resources/11.13.18.05/FlexFndDffDescriptiveFlexfieldContexts

Parameters:

• finder: ValidValuesFinder%3BBind_ApplicationId%3D10493%2CBind_DescriptiveFlexfieldCode%3DWIE_OPERATION_TRANSACTIONS

Abbreviation that identifies each descriptive flexfield that is defined for the operation transaction.

The following properties are defined on the LOV link relation:

• Source Attribute: __FLEX_Context; Target Attribute: ContextCode
• Display Attribute: Name

Back to Top

Examples

This example describes how to create one descriptive flexfield in one operation transaction detail in one operation 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.action+json" -d 'request payload' "https://servername/fscmRestApi/resources/version/operationTransactions"

Note that you use the action for the parent resource in the cURL command. You specify child details in the request payload. For example, you use a POST on the parent operationTransactions, and specify details for child OperationTransactionDFF in the request payload.

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.

{

"SourceSystemCode" : "SAP",
"OperationTransactionDetail" : [ {
        "SourceSystemCode" : "SAP",
        "OrganizationCode" : "M1",
        "WorkOrderNumber" : "M1-1136",
        "WoOperationSequenceNumber" : 10,
        "FromDispatchState" : "READY",
        "ToDispatchState" : "COMPLETE",
        "TransactionQuantity" : 1,
        "TransactionUnitOfMeasure" : "Each",
        "ComplSubinventoryCode" : null,
        "CompletionLocator" : null,
        "ReasonCode" : null,
        "TransactionNote" : null,
        "PONumber" : null,
        "POLineNumber" : null,
        "SoldToLegalEntityName" : null,
        "OperationTransactionDFF": [{
        "off" : 1
        }]
   }]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
"SourceSystemType": "EXTERNAL",
"SourceSystemCode": "SAP",
"ErrorsExistFlag": "false",
"OperationTransactionDetail": [
  
{
"WoOperationTransactionId": 51649,
"SourceSystemCode": "SAP",
"OrganizationCode": "M1",
"WorkOrderNumber": "M1-1136",
"WoOperationSequenceNumber": 10,
"TransactionDate": "2017-10-15T05:44:18.053+00:00",
"FromDispatchState": "READY",
"ToDispatchState": "COMPLETE",
"TransactionQuantity": 1,
"TransactionUOMCode": null,
"TransactionUnitOfMeasure": "Each",
"ComplSubinventoryCode": null,
"ReasonCode": null,
"TransactionNote": null,
"PONumber": null,
"POLineNumber": null,
"SoldToLegalEntityName": null,
"CompletionLocator": null,
"ErrorMessages": "",
"ErrorMessageNames": "",
"InspectionEventId": null,
"OperationTransactionDFF": [
  
{
"InterfaceRowId": 300100124132542,
"off": 1,
"__FLEX_Context": null,
"__FLEX_Context_DisplayValue": null,
...
}

Back to Top