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

Supported Media Types

• application/json

Body ()

Root Schema : PricingExportImportAction

Type: object

Show Source

• chargeq: object The chargeq Parameter
  Title: The chargeq Parameter

  Filter charges (a ???where???clause) to restrict the items returned in the export. The chargeq filtering is applied jointly ???AND???) with the q parameter. You can filter by searchable price model item columns and charge columns, for example, partNumber, bomItemVariableName, chargeType, priceType, and searchable custom charge attributes. You can't search by join fields like description, slaesProductType, ratePlanName or currency custom charge attributes.
• companyId: integer()
  Title: Company ID

  The company ID.
• companyName: string()
  Title: Company Name

  The company name.
• entity: string()
  Title: Entity

  Allowed Values: [ "matrixGrid", "scriptingMatrixData", "pricingGrid", "matrixData" ]

  The type of Pricing entity.
• File Names: array File Names
  Title: File Names

  The file names with path
• fileName: string()
  Title: File Name

  The file name with path.
• id: string()
  Title: Id

  The identifier of the Pricing entity.
• modifiedOnOrAfter: string()
  Title: Modified On Or After

  The last modified date for output export filter.
• q: object The q Parameter
  Title: The q Parameter

  Filter (a ???where???clause) to restrict the items returned in the export.
• resourceMethodName: string()
  Title: Resource Method Name

  The resource method name. For internal use only.
• resourceName: string()
  Title: Resource Name

  The resource name. For internal use only.
• Uploaded File Name: string()
  Title: Uploaded File Name

  The name of the CSV/zipped file that is uploaded
• userId: integer()
  Title: User ID

  The ID of logged in user.
• versionNumber: integer()
  Title: Resource Version Number

  The resource version number. For internal use only.

{
    "properties":{
        "entity":{
            "type":"string",
            "format":"",
            "description":"The type of Pricing entity.",
            "title":"Entity",
            "enum":[
                "matrixGrid",
                "scriptingMatrixData",
                "pricingGrid",
                "matrixData"
            ]
        },
        "id":{
            "type":"string",
            "format":"",
            "description":"The identifier of the Pricing entity.",
            "title":"Id"
        },
        "modifiedOnOrAfter":{
            "type":"string",
            "format":"",
            "description":"The last modified date for output export filter.",
            "title":"Modified On Or After"
        },
        "q":{
            "type":"object",
            "format":"",
            "description":"Filter (a ???where???clause) to restrict the items returned in the export.",
            "title":"The q Parameter"
        },
        "chargeq":{
            "type":"object",
            "format":"",
            "description":"Filter charges (a ???where???clause) to restrict the items returned in the export. The chargeq filtering is applied jointly ???AND???) with the q parameter. You can filter by searchable price model item columns and charge columns, for example, partNumber, bomItemVariableName, chargeType, priceType, and searchable custom charge attributes. You can't search by join fields like description, slaesProductType, ratePlanName or currency custom charge attributes.",
            "title":"The chargeq Parameter"
        },
        "versionNumber":{
            "type":"integer",
            "format":"",
            "description":"The resource version number. For internal use only.",
            "title":"Resource Version Number"
        },
        "resourceName":{
            "type":"string",
            "format":"",
            "description":"The resource name. For internal use only.",
            "title":"Resource Name"
        },
        "resourceMethodName":{
            "type":"string",
            "format":"",
            "description":"The resource method name. For internal use only.",
            "title":"Resource Method Name"
        },
        "fileName":{
            "type":"string",
            "format":"",
            "description":"The file name with path.",
            "title":"File Name"
        },
        "companyName":{
            "type":"string",
            "format":"",
            "description":"The company name.",
            "title":"Company Name"
        },
        "companyId":{
            "type":"integer",
            "format":"",
            "description":"The company ID.",
            "title":"Company ID"
        },
        "userId":{
            "type":"integer",
            "format":"",
            "description":"The ID of logged in user.",
            "title":"User ID"
        },
        "File Names":{
            "type":"array",
            "format":"",
            "description":"The file names with path",
            "title":"File Names",
            "items":{
                "type":"string"
            }
        },
        "Uploaded File Name":{
            "type":"string",
            "format":"",
            "description":"The name of the CSV/zipped file that is uploaded",
            "title":"Uploaded File Name"
        }
    }
}

Nested Schema : The chargeq Parameter

Type: object

Title: The chargeq Parameter

Filter charges (a ???where???clause) to restrict the items returned in the export. The chargeq filtering is applied jointly ???AND???) with the q parameter. You can filter by searchable price model item columns and charge columns, for example, partNumber, bomItemVariableName, chargeType, priceType, and searchable custom charge attributes. You can't search by join fields like description, slaesProductType, ratePlanName or currency custom charge attributes.

Nested Schema : File Names

Type: array

Title: File Names

The file names with path

Show Source

• Array of: string

{
    "type":"array",
    "format":"",
    "description":"The file names with path",
    "title":"File Names",
    "items":{
        "type":"string"
    }
}

Nested Schema : The q Parameter

Type: object

Title: The q Parameter

Filter (a ???where???clause) to restrict the items returned in the export.

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