Jump to

• Request
• Response
• Examples

Get Commerce Process Integration Settings

get

/rest/v19/commerceProcessSetups/integrationSettings

Use this endpoint to retrieve Commerce Process integration settings.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : AdminIntegrationSettingsModel

Type: object

Show Source

• defaultBatchSize: integer()
  Title: Default Batch Size

  Default Batch Size used for Integration
• docSelections: Document Selections
  Title: Document Selections

  Document Selections list for dropdown
• instanceTypes: Instance Types
  Title: Instance Types

  Instance Types list for dropdown
• lineTypeFilters: Line Type Filters
  Title: Line Type Filters

  Line Type Filters list for dropdown

{
    "properties":{
        "defaultBatchSize":{
            "type":"integer",
            "format":"",
            "description":"Default Batch Size used for Integration",
            "title":"Default Batch Size"
        },
        "instanceTypes":{
            "format":"",
            "description":"Instance Types list for dropdown",
            "title":"Instance Types",
            "allOf":[
                {
                    "$ref":"#/definitions/ResponseCollectionModel_AdminIntegrationSelectionItemModel"
                }
            ]
        },
        "lineTypeFilters":{
            "format":"",
            "description":"Line Type Filters list for dropdown",
            "title":"Line Type Filters",
            "allOf":[
                {
                    "$ref":"#/definitions/ResponseCollectionModel_AdminIntegrationSelectionItemModel"
                }
            ]
        },
        "docSelections":{
            "format":"",
            "description":"Document Selections list for dropdown",
            "title":"Document Selections",
            "allOf":[
                {
                    "$ref":"#/definitions/ResponseCollectionModel_AdminIntegrationSelectionItemModel"
                }
            ]
        }
    }
}

Nested Schema : Document Selections

Title: Document Selections

Document Selections list for dropdown

Match All

Document Selections list for dropdown

Show Source

• object ResponseCollectionModel_AdminIntegrationSelectionItemModel

{
    "format":"",
    "description":"Document Selections list for dropdown",
    "title":"Document Selections",
    "allOf":[
        {
            "$ref":"#/definitions/ResponseCollectionModel_AdminIntegrationSelectionItemModel"
        }
    ]
}

Nested Schema : Instance Types

Title: Instance Types

Instance Types list for dropdown

Match All

Instance Types list for dropdown

Show Source

• object ResponseCollectionModel_AdminIntegrationSelectionItemModel

{
    "format":"",
    "description":"Instance Types list for dropdown",
    "title":"Instance Types",
    "allOf":[
        {
            "$ref":"#/definitions/ResponseCollectionModel_AdminIntegrationSelectionItemModel"
        }
    ]
}

Nested Schema : Line Type Filters

Title: Line Type Filters

Line Type Filters list for dropdown

Match All

Line Type Filters list for dropdown

Show Source

• object ResponseCollectionModel_AdminIntegrationSelectionItemModel

{
    "format":"",
    "description":"Line Type Filters list for dropdown",
    "title":"Line Type Filters",
    "allOf":[
        {
            "$ref":"#/definitions/ResponseCollectionModel_AdminIntegrationSelectionItemModel"
        }
    ]
}

Nested Schema : ResponseCollectionModel_AdminIntegrationSelectionItemModel

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AdminIntegrationSelectionItemModel"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object AdminIntegrationSelectionItemModel

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AdminIntegrationSelectionItemModel"
    }
}

Nested Schema : AdminIntegrationSelectionItemModel

Type: object

Show Source

• displayValue: string
• value: string

{
    "properties":{
        "value":{
            "type":"string"
        },
        "displayValue":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve Commerce Process integration settings by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/commerceProcessSetups/integrationSettings

Response Body Sample

{
  "defaultBatchSize": 500,
  "instanceTypes": {
    "items": [{
        "value": "GENERIC",
        "displayValue": "Always Run"
      }, {
        "value": "DYNAMICS",
        "displayValue": "Requires Partner Session"
      }
    ]
  },
  "lineTypeFilters": {
    "items": [{
        "value": "ROOT_LINES",
        "displayValue": "Root Lines"
      }, {
        "value": "PART_LINES",
        "displayValue": "Part Lines"
      }, {
        "value": "ALL_LINES",
        "displayValue": "All Lines"
      }, {
        "value": "CUSTOM",
        "displayValue": "Custom"
      }
    ]
  },
  "docSelections": {
    "items": [{
        "value": "MAIN_DOCUMENT",
        "displayValue": "Main Document"
      }, {
        "value": "SUB_DOCUMENT",
        "displayValue": "Sub Document"
      }
    ]
  }
}

Back to Top