Jump to

• Request
• Response
• Examples

Export a Pricing Entity

post

/rest/v19/pricingSetup/actions/export

Use this endpoint to export a pricing entity. Only price model and price agreement matrix grids are supported at this time.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

202 Response

Success

Body ()

Root Schema : PricingTaskResponse

Type: object

Show Source

• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• messages: Task Submission Response Messages
  Title: Task Submission Response Messages

  Read Only: true

  List of task submission response messages.
• taskId: integer()
  Title: Task ID

  Task Identifier.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "taskId":{
            "type":"integer",
            "format":"",
            "description":"Task Identifier.",
            "title":"Task ID"
        },
        "messages":{
            "format":"",
            "description":"List of task submission response messages.",
            "title":"Task Submission Response Messages",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingTaskResponseMessage"
                }
            ]
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Task Submission Response Messages

Title: Task Submission Response Messages

Read Only: true

List of task submission response messages.

Match All

List of task submission response messages.

Show Source

• object PricingTaskResponseMessage

{
    "format":"",
    "description":"List of task submission response messages.",
    "title":"Task Submission Response Messages",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingTaskResponseMessage"
        }
    ]
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : PricingTaskResponseMessage

Type: object

Show Source

• errors: array Error messages
  Title: Error messages

  The list of error messages.
• info: array Informational messages
  Title: Informational messages

  The list of informational messages.
• warnings: array Warning messages
  Title: Warning messages

  The list of warning messages.

{
    "properties":{
        "info":{
            "type":"array",
            "format":"",
            "description":"The list of informational messages.",
            "title":"Informational messages",
            "items":{
                "type":"string"
            }
        },
        "warnings":{
            "type":"array",
            "format":"",
            "description":"The list of warning messages.",
            "title":"Warning messages",
            "items":{
                "type":"string"
            }
        },
        "errors":{
            "type":"array",
            "format":"",
            "description":"The list of error messages.",
            "title":"Error messages",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : Error messages

Type: array

Title: Error messages

The list of error messages.

Show Source

• Array of: string

{
    "type":"array",
    "format":"",
    "description":"The list of error messages.",
    "title":"Error messages",
    "items":{
        "type":"string"
    }
}

Nested Schema : Informational messages

Type: array

Title: Informational messages

The list of informational messages.

Show Source

• Array of: string

{
    "type":"array",
    "format":"",
    "description":"The list of informational messages.",
    "title":"Informational messages",
    "items":{
        "type":"string"
    }
}

Nested Schema : Warning messages

Type: array

Title: Warning messages

The list of warning messages.

Show Source

• Array of: string

{
    "type":"array",
    "format":"",
    "description":"The list of warning messages.",
    "title":"Warning messages",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

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

Only price model and price agreement matrix grids are supported at this time.

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

Request Body Sample

{
  "entity": "matrixGrid",
  "id": "test2"
}

Response Body Sample

{
  "taskId": 3023175064,
  "links": [{
      "rel": "related",
      "href": "http://sitename.oracle.com/rest/v19/tasks/3023175064"
    }
  ]
}

Back to Top