Jump to

• Request
• Response
• Examples

Get Commerce Integration Settings

get

/rest/v19/commerceProcessSetups/integrationSettings

Use this endpoint to retrieve settings for the specified commerce integration.

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
• fusionActive: object fusionActive
• icsProperties: Integration Cloud Service Properties
  Title: Integration Cloud Service Properties

  Integration Cloud Service(ICS) configuration properties in Integration Center
• instanceTypes: Instance Types
  Title: Instance Types

  Instance Types list for dropdown
• isFusionActive: boolean()
  Title: Is Fusion Active

  Returns true if CRM Integration vendor is Fusion
• isSalesForceActive: boolean()
  Title: Is SalesForce Active

  Returns true if CRM Integration vendor is SalesForce
• lineTypeFilters: Line Type Filters
  Title: Line Type Filters

  Line Type Filters list for dropdown
• propertyTypes: Integration Property types
  Title: Integration Property types

  Integration Property types
• salesForceActive: object salesForceActive

{
    "properties":{
        "defaultBatchSize":{
            "type":"integer",
            "format":"",
            "description":"Default Batch Size used for Integration",
            "title":"Default Batch Size"
        },
        "isFusionActive":{
            "type":"boolean",
            "format":"",
            "description":"Returns true if CRM Integration vendor is Fusion",
            "title":"Is Fusion Active"
        },
        "isSalesForceActive":{
            "type":"boolean",
            "format":"",
            "description":"Returns true if CRM Integration vendor is SalesForce",
            "title":"Is SalesForce Active"
        },
        "icsProperties":{
            "format":"",
            "description":"Integration Cloud Service(ICS) configuration properties in Integration Center",
            "title":"Integration Cloud Service Properties",
            "allOf":[
                {
                    "$ref":"#/definitions/IntegrationCloudServiceModel"
                }
            ]
        },
        "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"
                }
            ]
        },
        "propertyTypes":{
            "format":"",
            "description":"Integration Property types",
            "title":"Integration Property types",
            "allOf":[
                {
                    "$ref":"#/definitions/ResponseCollectionModel_AdminIntegrationSelectionItemModel"
                }
            ]
        },
        "fusionActive":{
            "type":"object"
        },
        "salesForceActive":{
            "type":"object"
        }
    }
}

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 : fusionActive

Type: object

Nested Schema : Integration Cloud Service Properties

Title: Integration Cloud Service Properties

Integration Cloud Service(ICS) configuration properties in Integration Center

Match All

Integration Cloud Service(ICS) configuration properties in Integration Center

Show Source

• object IntegrationCloudServiceModel

{
    "format":"",
    "description":"Integration Cloud Service(ICS) configuration properties in Integration Center",
    "title":"Integration Cloud Service Properties",
    "allOf":[
        {
            "$ref":"#/definitions/IntegrationCloudServiceModel"
        }
    ]
}

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 : Integration Property types

Title: Integration Property types

Integration Property types

Match All

Integration Property types

Show Source

• object ResponseCollectionModel_AdminIntegrationSelectionItemModel

{
    "format":"",
    "description":"Integration Property types",
    "title":"Integration Property types",
    "allOf":[
        {
            "$ref":"#/definitions/ResponseCollectionModel_AdminIntegrationSelectionItemModel"
        }
    ]
}

Nested Schema : salesForceActive

Type: object

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.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• 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"
            }
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object AdminIntegrationSelectionItemModel

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

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 : AdminIntegrationSelectionItemModel

Type: object

Show Source

• displayValue: string
• numericValue: integer(int32)
• value: string

{
    "properties":{
        "value":{
            "type":"string"
        },
        "displayValue":{
            "type":"string"
        },
        "numericValue":{
            "type":"integer",
            "format":"int32"
        }
    }
}

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 : IntegrationCloudServiceModel

Type: object

Show Source

• generation: string()
  Title: Generation

  Generation type of the configured ICS
• isConfigured: boolean()
  Title: Is Configured

  Is ICS configured in Integration Center
• isEnabled: boolean()
  Title: Is Enabled

  Is ICS enabled in integration centre

{
    "properties":{
        "isConfigured":{
            "type":"boolean",
            "format":"",
            "description":"Is ICS configured in Integration Center",
            "title":"Is Configured"
        },
        "generation":{
            "type":"string",
            "format":"",
            "description":"Generation type of the configured ICS",
            "title":"Generation"
        },
        "isEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Is ICS enabled in integration centre",
            "title":"Is Enabled"
        }
    }
}

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