Jump to

• Request
• Response
• Examples

Get Commerce Integration Types

get

/rest/v19/commerceProcessSetups/integrationTypes

Use this endpoint to retrieve integration types for the specified commerce process.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : AdminCollectionResponseModel_AdminIntegrationTypesModel

Type: object

Show Source

• items: array items

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

Nested Schema : items

Type: array

Show Source

• Array of: object AdminIntegrationTypesModel

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

Nested Schema : AdminIntegrationTypesModel

Type: object

Show Source

• displayLabel: string()
  Title: Display label

  Language Translated display label for the type
• displayOptions: displayOptions
  Title: displayOptions

  Display Links for each Integration Types
• enabled: boolean()
  Title: Enabled

  Indicates whether type is enabled or not
• enumType: string()
  Title: EnumType

  Enum label used for the Integration Type
• isHidden: boolean()
  Title: Is Hidden

  Indicates whether type is hidden or not
• label: string()
  Title: Label

  Label for the type
• type: string()
  Title: Type

  Key value of the Type

{
    "properties":{
        "label":{
            "type":"string",
            "format":"",
            "description":"Label for the type",
            "title":"Label"
        },
        "displayLabel":{
            "type":"string",
            "format":"",
            "description":"Language Translated display label for the type",
            "title":"Display label"
        },
        "type":{
            "type":"string",
            "format":"",
            "description":"Key value of the Type",
            "title":"Type"
        },
        "enabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether type is enabled or not",
            "title":"Enabled"
        },
        "isHidden":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether type is hidden or not",
            "title":"Is Hidden"
        },
        "enumType":{
            "type":"string",
            "format":"",
            "description":"Enum label used for the Integration Type",
            "title":"EnumType"
        },
        "displayOptions":{
            "format":"",
            "description":"Display Links for each Integration Types",
            "title":"displayOptions",
            "allOf":[
                {
                    "$ref":"#/definitions/IntegrationDisplayOptions"
                }
            ]
        }
    }
}

Nested Schema : displayOptions

Title: displayOptions

Display Links for each Integration Types

Match All

Display Links for each Integration Types

Show Source

• object IntegrationDisplayOptions

{
    "format":"",
    "description":"Display Links for each Integration Types",
    "title":"displayOptions",
    "allOf":[
        {
            "$ref":"#/definitions/IntegrationDisplayOptions"
        }
    ]
}

Nested Schema : IntegrationDisplayOptions

Type: object

Show Source

• inputXmlForSoapGenerator: boolean()
  Title: Input XML for SOAP Generator

  Show Input XML for SOAP Generator link
• previewExportResponse: boolean()
  Title: Preview Export Response

  Show Preview Export Response link
• previewMiddlewareResponse: boolean()
  Title: Preview Middleware Response

  Show Preview Middleware Response link
• previewParsedResponse: boolean()
  Title: Preview Parsed Response

  Show Preview Parsed Response link
• previewParserResult: boolean()
  Title: Preview Parser Result

  Show Preview Parser Result link
• previewPartnerResponse: boolean()
  Title: Preview Partner Response

  Show Preview Partner Response link
• previewQueryResult: boolean()
  Title: Preview Query Result

  Show Preview Query Result link
• previewRequest: boolean()
  Title: Preview Request

  Show Preview Request link
• previewSoapXml: boolean()
  Title: Preview SOAP XML

  Show Preview SOAP XML link
• testIntegration: boolean()
  Title: Test Integration

  Show Test Integration link

{
    "properties":{
        "previewExportResponse":{
            "type":"boolean",
            "format":"",
            "description":"Show Preview Export Response link",
            "title":"Preview Export Response"
        },
        "previewQueryResult":{
            "type":"boolean",
            "format":"",
            "description":"Show Preview Query Result link",
            "title":"Preview Query Result"
        },
        "previewParserResult":{
            "type":"boolean",
            "format":"",
            "description":"Show Preview Parser Result link",
            "title":"Preview Parser Result"
        },
        "previewRequest":{
            "type":"boolean",
            "format":"",
            "description":"Show Preview Request link",
            "title":"Preview Request"
        },
        "previewPartnerResponse":{
            "type":"boolean",
            "format":"",
            "description":"Show Preview Partner Response link",
            "title":"Preview Partner Response"
        },
        "previewParsedResponse":{
            "type":"boolean",
            "format":"",
            "description":"Show Preview Parsed Response link",
            "title":"Preview Parsed Response"
        },
        "previewSoapXml":{
            "type":"boolean",
            "format":"",
            "description":"Show Preview SOAP XML link",
            "title":"Preview SOAP XML"
        },
        "previewMiddlewareResponse":{
            "type":"boolean",
            "format":"",
            "description":"Show Preview Middleware Response link",
            "title":"Preview Middleware Response"
        },
        "testIntegration":{
            "type":"boolean",
            "format":"",
            "description":"Show Test Integration link",
            "title":"Test Integration"
        },
        "inputXmlForSoapGenerator":{
            "type":"boolean",
            "format":"",
            "description":"Show Input XML for SOAP Generator link",
            "title":"Input XML for SOAP Generator"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve integration types for the specified Commerce Process 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/oraclecpqo/integrationTypes

Response Body Sample

{
  "items":
  [{
      "label": "Integration Cloud Service",
      "displayLabel": "Integration Cloud Service",
      "type": "MIDDLEWARE_IMPORT",
      "enabled": true
    }, {
      "name": "BML",
      "displayLabel": "[BML]",
      "type": "BML",
      "enabled": true
    }
  ]
}

Back to Top