Jump to

• Request
• Response
• Examples

Import purchase agreements

post

/fscmRestApi/resources/11.13.18.05/purchaseAgreementImportRequests/{InterfaceHeaderId}/action/importPurchaseAgreements

Imports purchase agreements from external systems into Oracle Fusion Purchasing.

Request

Path Parameters

• InterfaceHeaderId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• approvalActionCode: string
  Indicates whether to submit the document for approval after import or import the document as approved, or as draft. Valid values are SUBMIT, BYPASS, and NONE.
• batchId: string
  Value that uniquely identifies the batch.
• communicateAgreementsFlag: boolean
  Indicates if imported purchase agreements should be communicated to suppliers.
• createOrUpdateItemFlag: boolean
  Indicates whether items in the blanket purchase agreement should be created if they don't exist or an existing item should be updated.
• defaultBuyer: string
  Name of the buyer to be used when a buyer isn't included in the import data.
• documentTypeCode: string
  Value that identifies the document type to be created. Valid values are BLANKET and CONTRACT.
• importSource: string
  Value that identifies the source application from which the document was imported.
• procurementBU: string
  Name of the procurement business unit that the purchase agreement should be imported into.

{
    "type":"object",
    "properties":{
        "approvalActionCode":{
            "type":"string",
            "description":"Indicates whether to submit the document for approval after import or import the document as approved, or as draft. Valid values are SUBMIT, BYPASS, and NONE.",
            "nullable":true
        },
        "documentTypeCode":{
            "type":"string",
            "description":"Value that identifies the document type to be created. Valid values are BLANKET and CONTRACT.",
            "nullable":true
        },
        "createOrUpdateItemFlag":{
            "type":"boolean",
            "description":"Indicates whether items in the blanket purchase agreement should be created if they don't exist or an existing item should be updated.",
            "nullable":true
        },
        "procurementBU":{
            "type":"string",
            "description":"Name of the procurement business unit that the purchase agreement should be imported into.",
            "nullable":true
        },
        "defaultBuyer":{
            "type":"string",
            "description":"Name of the buyer to be used when a buyer isn't included in the import data.",
            "nullable":true
        },
        "importSource":{
            "type":"string",
            "description":"Value that identifies the source application from which the document was imported.",
            "nullable":true
        },
        "batchId":{
            "type":"string",
            "description":"Value that uniquely identifies the batch.",
            "nullable":true
        },
        "communicateAgreementsFlag":{
            "type":"boolean",
            "description":"Indicates if imported purchase agreements should be communicated to suppliers.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  Indicates the request identifier for the import job.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Indicates the request identifier for the import job."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

This example describes how to submit a purchase agreement import request. To submit the request, you must provide the required parameters, documentTypeCode, procurementBU, approvalActionCode, and defaultBuyer. The response returns a Request ID.

Note:

To submit the request, users additionally need the Import Blanket Purchase Agreement and Import Contract Purchase Agreement privileges for importing blanket purchase agreements and contract purchase agreements respectively.

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/purchaseAgreementImportRequests/InterfaceHeaderId/action/importPurchaseAgreements"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/purchaseAgreementImportRequests/300100590199617/action/importPurchaseAgreements"

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

{
  "documentTypeCode": "BLANKET",
  "procurementBU": "Vision Operations",
  "defaultBuyer": "Furey,Clare",
  "approvalActionCode": "BYPASS",
  "communicateAgreementsFlag": null,
  "importSource": null,
  "batchId": "1234",
  "createOrUpdateItemFlag": null
}

Example Response Body

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

{
  "result" : "Request ID 158307 was submitted."
}

Back to Top