Jump to

• Request
• Response
• Examples

Export Transactions

post

/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_export_transactions

Use this endpoint to export selected data column values for all selected transactions in a zipped excel file.

Request

Supported Media Types

• application/json

Body ()

Root Schema : commerceDocumentsOraclecpqoTransaction-_export_transactionsCollectionRequest

Type: object

Show Source

• selectionCriteria: object Selection Query Definition
  Title: Selection Query Definition

  Captures the query definition for resource requests, specifically for collection-based process actions.

{
    "type":"object",
    "properties":{
        "selectionCriteria":{
            "$ref":"#/definitions/selectionQueryDef"
        }
    }
}

Nested Schema : Selection Query Definition

Type: object

Title: Selection Query Definition

Captures the query definition for resource requests, specifically for collection-based process actions.

Show Source

• fields: array fields
  Array of field names for display.
• orderBy: array orderBy
  Array of field names, each optionally followed by asc or desc, that specifies the order of items filtered.
• q: string
  Filter (a "where" clause) to restrict the items returned in the collection. By default, no filtering is applied.
• search: string
  Seeded Search Name

{
    "type":"object",
    "properties":{
        "search":{
            "type":"string",
            "description":"Seeded Search Name"
        },
        "q":{
            "type":"string",
            "description":"Filter (a \"where\" clause) to restrict the items returned in the collection. By default, no filtering is applied."
        },
        "orderBy":{
            "type":"array",
            "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items filtered.",
            "items":{
                "type":"string"
            }
        },
        "fields":{
            "type":"array",
            "description":"Array of field names for display.",
            "items":{
                "type":"string"
            }
        }
    },
    "title":"Selection Query Definition",
    "description":"Captures the query definition for resource requests, specifically for collection-based process actions."
}

Nested Schema : fields

Type: array

Array of field names for display.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names for display.",
    "items":{
        "type":"string"
    }
}

Nested Schema : orderBy

Type: array

Array of field names, each optionally followed by asc or desc, that specifies the order of items filtered.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Array of field names, each optionally followed by asc or desc, that specifies the order of items filtered.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : commerceDocumentsOraclecpqoTransaction-_export_transactionsCollectionResponse

Type: object

Show Source

• fileUrl: string
  Title: File URL

  The URL of the file.
• warnings: object warnings
  Title: warnings

  warning messages

{
    "type":"object",
    "properties":{
        "warnings":{
            "$ref":"#/definitions/warnings"
        },
        "fileUrl":{
            "type":"string",
            "description":"The URL of the file.",
            "title":"File URL"
        }
    }
}

Nested Schema : warnings

Type: object

Title: warnings

warning messages

Show Source

• messages: array Messages
  Title: Messages

  Array of messages that have been generated for a specific object.

{
    "type":"object",
    "properties":{
        "messages":{
            "type":"array",
            "description":"Array of messages that have been generated for a specific object.",
            "title":"Messages",
            "items":{
                "type":"string",
                "description":"warning message."
            }
        }
    },
    "title":"warnings",
    "description":"warning messages"
}

Nested Schema : Messages

Type: array

Title: Messages

Array of messages that have been generated for a specific object.

Show Source

• Array of: string
  warning message.

{
    "type":"array",
    "description":"Array of messages that have been generated for a specific object.",
    "title":"Messages",
    "items":{
        "type":"string",
        "description":"warning message."
    }
}

Back to Top

Examples

The following example shows how to export the specified Commerce transactions by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Content-type: application/json" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/commerceDocumentsOraclecpqoTransaction/actions/_export_transactions

Request Body Sample

{
  "selectionCriteria": {
    "search": "_my_approval_search",
    "orderby": ["_id:desc", "searchViewName:asc"],
    "fields": ["_id", "_lock_status", "bs_id", "processManagerFloat"]
  }
}

Response Body Sample

{
  "warnings": {},
  "fileUrl": "https://sitename.oracle.com/rest/v19/commerceExports/filename.zip"
}

Back to Top