Jump to

• Request
• Response
• Examples

Retrieve a Project

get

/ic/api/integration/v1/projects/{id}

Retrieves detailed information about the project.

Request

Path Parameters

• id(required): string
  Project identifier

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json;charset=utf-8, application/vnd.oracle.model+json;type=singular

200 Response

Successful operation

Body ()

Root Schema : ProjectTypeRs

Match All

Show Source

• allOf ProjectTypeBaseResource
• object GenericRestResource
• object ProjectTypeRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ProjectTypeBaseResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Project Name"
                },
                "code":{
                    "type":"string",
                    "description":"Project Identifier"
                },
                "keyword":{
                    "type":"string",
                    "description":"Project Keyword"
                },
                "type":{
                    "type":"string",
                    "description":"Project Type"
                },
                "access":{
                    "type":"string",
                    "description":"Project Access"
                },
                "builtBy":{
                    "type":"string",
                    "description":"Project BuiltBy"
                },
                "origin":{
                    "$ref":"#/components/schemas/Origin",
                    "description":"Project Origin"
                },
                "state":{
                    "$ref":"#/components/schemas/State",
                    "description":"Project State"
                },
                "smartTags":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    },
                    "description":"Project Smart Tags"
                },
                "description":{
                    "type":"string",
                    "description":"Project Description"
                },
                "label":{
                    "type":"string",
                    "description":"Project Deployment"
                }
            }
        }
    ]
}

Nested Schema : ProjectTypeBaseResource

Match All

Show Source

• object GenericRestResource
• object ProjectTypeBaseResource-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestResource

Type: object

Show Source

• links: array links
• processing-time: number (float)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "processing-time":{
            "type":"number",
            "format":"float"
        }
    }
}

Nested Schema : ProjectTypeBaseResource-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : ProjectTypeRs-allOf[2]

Type: object

Show Source

• access: string
  Project Access
• builtBy: string
  Project BuiltBy
• code: string
  Project Identifier
• description: string
  Project Description
• keyword: string
  Project Keyword
• label: string
  Project Deployment
• name: string
  Project Name
• origin: object Origin
• smartTags: array smartTags
  Project Smart Tags
• state: object State
• type: string
  Project Type

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Project Name"
        },
        "code":{
            "type":"string",
            "description":"Project Identifier"
        },
        "keyword":{
            "type":"string",
            "description":"Project Keyword"
        },
        "type":{
            "type":"string",
            "description":"Project Type"
        },
        "access":{
            "type":"string",
            "description":"Project Access"
        },
        "builtBy":{
            "type":"string",
            "description":"Project BuiltBy"
        },
        "origin":{
            "$ref":"#/components/schemas/Origin",
            "description":"Project Origin"
        },
        "state":{
            "$ref":"#/components/schemas/State",
            "description":"Project State"
        },
        "smartTags":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Project Smart Tags"
        },
        "description":{
            "type":"string",
            "description":"Project Description"
        },
        "label":{
            "type":"string",
            "description":"Project Deployment"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• media-type: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        }
    }
}

Nested Schema : Origin

Type: object

Show Source

• built-by: string
• code: string
• project: string
• service-instance: string
• tenant-id: string
• type: string
• version: string

{
    "type":"object",
    "properties":{
        "tenant-id":{
            "type":"string"
        },
        "service-instance":{
            "type":"string"
        },
        "project":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "built-by":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Nested Schema : smartTags

Type: array

Project Smart Tags

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Project Smart Tags"
}

Nested Schema : State

Type: object

Show Source

• assets: object Assets
• created: object ResourceModificationAttribute
• latest: object ResourceModificationAttribute
• lock-status: boolean
• locked: object ResourceModificationAttribute
• project-revision-id: integer (int32)
• service-instance-id: integer (int32)
• status: string
• updated: object ResourceModificationAttribute

{
    "type":"object",
    "properties":{
        "service-instance-id":{
            "type":"integer",
            "format":"int32"
        },
        "project-revision-id":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        },
        "assets":{
            "$ref":"#/components/schemas/Assets"
        },
        "updated":{
            "$ref":"#/components/schemas/ResourceModificationAttribute"
        },
        "created":{
            "$ref":"#/components/schemas/ResourceModificationAttribute"
        },
        "locked":{
            "$ref":"#/components/schemas/ResourceModificationAttribute"
        },
        "latest":{
            "$ref":"#/components/schemas/ResourceModificationAttribute"
        },
        "lock-status":{
            "type":"boolean"
        }
    }
}

Nested Schema : Assets

Type: object

Show Source

• certificates: CertificatesRs
• connections: object ConnectionsRs
• integrations: object IntegrationsRs
• labels-rs: object LabelsRs
• libraries: object LibraryRs
• lookups: object schema

{
    "type":"object",
    "properties":{
        "integrations":{
            "$ref":"#/components/schemas/IntegrationsRs"
        },
        "connections":{
            "$ref":"#/components/schemas/ConnectionsRs"
        },
        "lookups":{
            "$ref":"#/components/schemas/LookupRs"
        },
        "libraries":{
            "$ref":"#/components/schemas/LibraryRs"
        },
        "certificates":{
            "$ref":"#/components/schemas/CertificatesRs"
        },
        "labels-rs":{
            "$ref":"#/components/schemas/LabelsRs"
        }
    }
}

Nested Schema : ResourceModificationAttribute

Type: object

Show Source

• by: string
• date: string (date-time)

{
    "type":"object",
    "properties":{
        "by":{
            "type":"string"
        },
        "date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : CertificatesRs

Match All

Show Source

• object GenericRestRs
• object CertificatesRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/CertificateRs"
                    }
                },
                "totalResults":{
                    "type":"integer",
                    "format":"int32"
                },
                "hasMore":{
                    "type":"boolean"
                },
                "limit":{
                    "type":"integer",
                    "format":"int32"
                }
            }
        }
    ]
}

Nested Schema : ConnectionsRs

Type: object

Show Source

• has-more: boolean
  Flag to Check if More Records Exists
• items: array items
  List of Connections
• limit: integer (int32)
  Limit of Records to be Displayed
• links: array links
  Suite Link List
• total-results: integer (int32)
  Total Results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Connections",
            "items":{
                "$ref":"#/components/schemas/ConnectionRs"
            }
        },
        "links":{
            "type":"array",
            "description":"Suite Link List",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32"
        },
        "limit":{
            "type":"integer",
            "description":"Limit of Records to be Displayed",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Flag to Check if More Records Exists"
        }
    }
}

Nested Schema : IntegrationsRs

Type: object

Show Source

• has-more: boolean
  Flag to Check if More Records Exists
• items: array items
  List of Integrations
• limit: integer (int32)
  Limit of Records to be Displayed
• total-results: integer (int32)
  Total Results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Integrations",
            "items":{
                "$ref":"#/components/schemas/IntegrationListRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Flag to Check if More Records Exists"
        },
        "limit":{
            "type":"integer",
            "description":"Limit of Records to be Displayed",
            "format":"int32"
        }
    }
}

Nested Schema : LabelsRs

Type: object

Show Source

• items: array items
  List of Deployments

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Deployments",
            "items":{
                "$ref":"#/components/schemas/LabelRs"
            }
        }
    }
}

Nested Schema : LibraryRs

Type: object

Show Source

• has-more: boolean
  Flag to Check if More Records Exists
• items: array items
  List of Libraries
• limit: integer (int32)
  Limit of Records to be Displayed
• total-results: integer (int32)
  Total Results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Libraries",
            "items":{
                "$ref":"#/components/schemas/LibraryTypeRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Flag to Check if More Records Exists"
        },
        "limit":{
            "type":"integer",
            "description":"Limit of Records to be Displayed",
            "format":"int32"
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• adapters: array adapters
  Adapter List
• columns: array columns
  Column List
• created: string (date-time)
  Created Date
• created-by: string
  Created By
• description: string
  Lookup Description
• keywords: string
  Keywords
• last-updated: string (date-time)
  Last Updated
• last-updated-by: string
  Last Updated By
• locked-by: string
  Locked By
• locked-date: string (date-time)
  Locked Date
• locked-dvm-flag: boolean
  Locked DVM Flag
• locked-flag: boolean
  Locked Flag
• name: string
  Lookup Name
• resource-path: string
  Resource Path
• row-count: integer (int32)
  Lookup Row Count
• rows: array rows
  Row List
• rows-as-array: array rows-as-array
• status: string
  Lookup Status
• usage: integer (int32)
  Lookup Usage
• usage-active: integer (int32)
  Lookup Active Usage

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Lookup Name"
        },
        "description":{
            "type":"string",
            "description":"Lookup Description"
        },
        "row-count":{
            "type":"integer",
            "description":"Lookup Row Count",
            "format":"int32"
        },
        "status":{
            "type":"string",
            "description":"Lookup Status"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "last-updated":{
            "type":"string",
            "description":"Last Updated",
            "format":"date-time"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "locked-dvm-flag":{
            "type":"boolean",
            "description":"Locked DVM Flag"
        },
        "columns":{
            "type":"array",
            "description":"Column List",
            "items":{
                "type":"string"
            }
        },
        "created":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "adapters":{
            "type":"array",
            "description":"Adapter List",
            "items":{
                "$ref":"#/components/schemas/AdapterTypeRs"
            }
        },
        "usage":{
            "type":"integer",
            "description":"Lookup Usage",
            "format":"int32"
        },
        "usage-active":{
            "type":"integer",
            "description":"Lookup Active Usage",
            "format":"int32"
        },
        "rows":{
            "type":"array",
            "description":"Row List",
            "items":{
                "$ref":"#/components/schemas/SuiteLookupRowData"
            }
        },
        "rows-as-array":{
            "type":"array",
            "items":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            }
        },
        "resource-path":{
            "type":"string",
            "description":"Resource Path"
        },
        "keywords":{
            "type":"string",
            "description":"Keywords"
        }
    }
}

Nested Schema : GenericRestRs

Type: object

Show Source

• links: array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        }
    }
}

Nested Schema : CertificatesRs-allOf[1]

Type: object

Show Source

• hasMore: boolean
• items: array items
• limit: integer (int32)
• totalResults: integer (int32)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/CertificateRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean"
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• media-type: string
• method: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        },
        "method":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: CertificateRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/CertificateRs"
    }
}

Nested Schema : CertificateRs

Match All

Show Source

• allOf IdResource
• object GenericRestResource
• object CertificateRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "keystore":{
                    "type":"string"
                },
                "keyStoreDescription":{
                    "type":"string"
                },
                "name":{
                    "type":"string"
                },
                "description":{
                    "type":"string"
                },
                "type":{
                    "type":"string"
                },
                "installedType":{
                    "type":"string"
                },
                "typeDescription":{
                    "type":"string"
                },
                "keyPasswords":{
                    "type":"string"
                },
                "keystorePassword":{
                    "type":"string"
                },
                "passPhrase":{
                    "type":"string"
                },
                "asciiArmored":{
                    "type":"boolean"
                },
                "cipherAlgorithm":{
                    "type":"string"
                },
                "issued":{
                    "type":"string",
                    "format":"date-time"
                },
                "expires":{
                    "type":"string",
                    "format":"date-time"
                },
                "status":{
                    "type":"string"
                },
                "createdBy":{
                    "type":"string"
                },
                "created":{
                    "type":"string",
                    "format":"date-time"
                },
                "lastUpdatedBy":{
                    "type":"string"
                },
                "lastUpdated":{
                    "type":"string",
                    "format":"date-time"
                },
                "metaData":{
                    "type":"object",
                    "additionalProperties":{
                        "type":"string"
                    }
                },
                "hash":{
                    "type":"string"
                },
                "content":{
                    "type":"array",
                    "items":{
                        "type":"string",
                        "format":"byte"
                    }
                },
                "secretOCID":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdResource

Match All

Show Source

• object GenericRestResource
• object IdResource-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "projectId":{
                    "type":"string"
                },
                "projectName":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdResource-allOf[1]

Type: object

Show Source

• id: string
• projectId: string
• projectName: string

{
    "type":"object",
    "properties":{
        "projectId":{
            "type":"string"
        },
        "projectName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : CertificateRs-allOf[2]

Type: object

Show Source

• asciiArmored: boolean
• cipherAlgorithm: string
• content: array content
• created: string (date-time)
• createdBy: string
• description: string
• expires: string (date-time)
• hash: string
• installedType: string
• issued: string (date-time)
• keyPasswords: string
• keystore: string
• keyStoreDescription: string
• keystorePassword: string
• lastUpdated: string (date-time)
• lastUpdatedBy: string
• metaData: object metaData
  Additional Properties Allowed: additionalProperties
• name: string
• passPhrase: string
• secretOCID: string
• status: string
• type: string
• typeDescription: string

{
    "type":"object",
    "properties":{
        "keystore":{
            "type":"string"
        },
        "keyStoreDescription":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "installedType":{
            "type":"string"
        },
        "typeDescription":{
            "type":"string"
        },
        "keyPasswords":{
            "type":"string"
        },
        "keystorePassword":{
            "type":"string"
        },
        "passPhrase":{
            "type":"string"
        },
        "asciiArmored":{
            "type":"boolean"
        },
        "cipherAlgorithm":{
            "type":"string"
        },
        "issued":{
            "type":"string",
            "format":"date-time"
        },
        "expires":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string"
        },
        "createdBy":{
            "type":"string"
        },
        "created":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "lastUpdated":{
            "type":"string",
            "format":"date-time"
        },
        "metaData":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "hash":{
            "type":"string"
        },
        "content":{
            "type":"array",
            "items":{
                "type":"string",
                "format":"byte"
            }
        },
        "secretOCID":{
            "type":"string"
        }
    }
}

Nested Schema : content

Type: array

Show Source

• Array of: string(byte)

{
    "type":"array",
    "items":{
        "type":"string",
        "format":"byte"
    }
}

Nested Schema : metaData

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

List of Connections

Show Source

• Array of: object schema

{
    "type":"array",
    "description":"List of Connections",
    "items":{
        "$ref":"#/components/schemas/ConnectionRs"
    }
}

Nested Schema : links

Type: array

Suite Link List

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "description":"Suite Link List",
    "items":{
        "$ref":"#/components/schemas/SuiteLink"
    }
}

Nested Schema : schema

Type: object

Show Source

• adapter: AdapterTypeRs
• adapter-type: AdapterTypeBaseRs
• admin-email: string
  Administrator's Email
• agent-group-id: string
  Agent Group Identifier
• agent-required: boolean
  Agent Required
• agent-supported: boolean
  Agent Supported
• connection-properties: array connection-properties
  List of Connection Properties
• created: string (date-time)
  Created
• created-by: string
  Created By
• description: string
  Description
• keywords: string
  Keywords
• last-refreshed-date: string (date-time)
  Last Refresh Date
• last-updated: string (date-time)
  Last Updated
• last-updated-by: string
  Last Updated By
• locked-by: string
  Locked By
• locked-date: string (date-time)
  Locked Date
• locked-flag: boolean
  Locked Flag
• metadata-download-state: string
  Metadata Download State
• metadata-download-supported-flag: boolean
  Metadata Download Supported Flag
• name: string
  Connection Name
• percentage-complete: number
  Connection Completion Percentage
• project-id: string
• refreshed-status: string
  Refreshed Status
• role: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• security-policy: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
• security-policy-info: array security-policy-info
  List of Security Policies
• security-properties: array security-properties
  List of Security Properties
• status: string
  Connection Status
• test-status: boolean
  Test Status
• usage: integer (int32)
  Usage
• usage-active: integer (int32)
  Active Usage
• wsdl-list-dir: array wsdl-list-dir
  List of WSDL

{
    "type":"object",
    "properties":{
        "test-status":{
            "type":"boolean",
            "description":"Test Status"
        },
        "wsdl-list-dir":{
            "type":"array",
            "description":"List of WSDL",
            "items":{
                "type":"string"
            }
        },
        "security-policy-info":{
            "type":"array",
            "description":"List of Security Policies",
            "items":{
                "$ref":"#/components/schemas/SecurityPolicyInfoRs"
            }
        },
        "metadata-download-supported-flag":{
            "type":"boolean",
            "description":"Metadata Download Supported Flag"
        },
        "metadata-download-state":{
            "type":"string",
            "description":"Metadata Download State"
        },
        "adapter-type":{
            "$ref":"#/components/schemas/AdapterTypeBaseRs"
        },
        "status":{
            "type":"string",
            "description":"Connection Status"
        },
        "connection-properties":{
            "type":"array",
            "description":"List of Connection Properties",
            "items":{
                "$ref":"#/components/schemas/ConnectionPropertyRs"
            }
        },
        "security-properties":{
            "type":"array",
            "description":"List of Security Properties",
            "items":{
                "$ref":"#/components/schemas/ConnectionPropertyRs"
            }
        },
        "name":{
            "type":"string",
            "description":"Connection Name"
        },
        "percentage-complete":{
            "type":"number",
            "description":"Connection Completion Percentage"
        },
        "security-policy":{
            "$ref":"#/components/schemas/SecurityPolicy"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "last-updated":{
            "type":"string",
            "description":"Last Updated",
            "format":"date-time"
        },
        "agent-group-id":{
            "type":"string",
            "description":"Agent Group Identifier"
        },
        "role":{
            "$ref":"#/components/schemas/AdapterIntegrationRole"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "description":{
            "type":"string",
            "description":"Description"
        },
        "created":{
            "type":"string",
            "description":"Created",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "adapter":{
            "$ref":"#/components/schemas/AdapterTypeRs"
        },
        "usage":{
            "type":"integer",
            "description":"Usage",
            "format":"int32"
        },
        "usage-active":{
            "type":"integer",
            "description":"Active Usage",
            "format":"int32"
        },
        "admin-email":{
            "type":"string",
            "description":"Administrator's Email"
        },
        "agent-supported":{
            "type":"boolean",
            "description":"Agent Supported"
        },
        "agent-required":{
            "type":"boolean",
            "description":"Agent Required"
        },
        "keywords":{
            "type":"string",
            "description":"Keywords"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "last-refreshed-date":{
            "type":"string",
            "description":"Last Refresh Date",
            "format":"date-time"
        },
        "refreshed-status":{
            "type":"string",
            "description":"Refreshed Status"
        },
        "project-id":{
            "type":"string"
        }
    }
}

Nested Schema : AdapterTypeRs

Match All

Show Source

• allOf AdapterTypeBaseRs
• allOf IdRs
• object GenericRestRs
• object AdapterTypeRs-allOf[3]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/AdapterTypeBaseRs"
        },
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "otherVersions":{
                    "type":"string"
                },
                "customSecurityPolicyDescription":{
                    "type":"string"
                },
                "oAuth3LeggedSupport":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SecurityPolicy"
                    }
                },
                "genericAuthSupport":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/SecurityPolicy"
                    }
                },
                "testKey":{
                    "type":"string"
                },
                "validateAndTestKey":{
                    "type":"string"
                },
                "testMessage":{
                    "type":"string"
                },
                "validateAndTestMessage":{
                    "type":"string"
                },
                "infoMessage":{
                    "type":"string"
                },
                "wsdlvalidation":{
                    "type":"boolean"
                },
                "vendorInfo":{
                    "$ref":"#/components/schemas/AdapterVendorInfo"
                },
                "supportedSecurityPolicies":{
                    "type":"string"
                },
                "features":{
                    "type":"string"
                },
                "version":{
                    "type":"string"
                },
                "description":{
                    "type":"string"
                },
                "integrationRole":{
                    "$ref":"#/components/schemas/AdapterIntegrationRole"
                },
                "defaultSecurityPolicies":{
                    "type":"string"
                },
                "icons":{
                    "$ref":"#/components/schemas/AdapterIconsRs"
                }
            }
        }
    ]
}

Nested Schema : AdapterTypeBaseRs

Match All

Show Source

• allOf IdRs
• object GenericRestRs
• object AdapterTypeBaseRs-allOf[2]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/IdRs"
        },
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "name":{
                    "type":"string"
                },
                "displayName":{
                    "type":"string"
                },
                "type":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : connection-properties

Type: array

List of Connection Properties

Show Source

• Array of: object ConnectionPropertyRs

{
    "type":"array",
    "description":"List of Connection Properties",
    "items":{
        "$ref":"#/components/schemas/ConnectionPropertyRs"
    }
}

Nested Schema : security-policy-info

Type: array

List of Security Policies

Show Source

• Array of: object SecurityPolicyInfoRs

{
    "type":"array",
    "description":"List of Security Policies",
    "items":{
        "$ref":"#/components/schemas/SecurityPolicyInfoRs"
    }
}

Nested Schema : security-properties

Type: array

List of Security Properties

Show Source

• Array of: object ConnectionPropertyRs

{
    "type":"array",
    "description":"List of Security Properties",
    "items":{
        "$ref":"#/components/schemas/ConnectionPropertyRs"
    }
}

Nested Schema : wsdl-list-dir

Type: array

List of WSDL

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of WSDL",
    "items":{
        "type":"string"
    }
}

Nested Schema : IdRs

Match All

Show Source

• object GenericRestRs
• object IdRs-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestRs"
        },
        {
            "type":"object",
            "properties":{
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : IdRs-allOf[1]

Type: object

Show Source

• id: string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : AdapterTypeBaseRs-allOf[2]

Type: object

Show Source

• displayName: string
• name: string
• type: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : AdapterTypeRs-allOf[3]

Type: object

Show Source

• customSecurityPolicyDescription: string
• defaultSecurityPolicies: string
• description: string
• features: string
• genericAuthSupport: array genericAuthSupport
• icons: object AdapterIconsRs
• infoMessage: string
• integrationRole: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• oAuth3LeggedSupport: array oAuth3LeggedSupport
• otherVersions: string
• supportedSecurityPolicies: string
• testKey: string
• testMessage: string
• validateAndTestKey: string
• validateAndTestMessage: string
• vendorInfo: object AdapterVendorInfo
• version: string
• wsdlvalidation: boolean

{
    "type":"object",
    "properties":{
        "otherVersions":{
            "type":"string"
        },
        "customSecurityPolicyDescription":{
            "type":"string"
        },
        "oAuth3LeggedSupport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SecurityPolicy"
            }
        },
        "genericAuthSupport":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SecurityPolicy"
            }
        },
        "testKey":{
            "type":"string"
        },
        "validateAndTestKey":{
            "type":"string"
        },
        "testMessage":{
            "type":"string"
        },
        "validateAndTestMessage":{
            "type":"string"
        },
        "infoMessage":{
            "type":"string"
        },
        "wsdlvalidation":{
            "type":"boolean"
        },
        "vendorInfo":{
            "$ref":"#/components/schemas/AdapterVendorInfo"
        },
        "supportedSecurityPolicies":{
            "type":"string"
        },
        "features":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "integrationRole":{
            "$ref":"#/components/schemas/AdapterIntegrationRole"
        },
        "defaultSecurityPolicies":{
            "type":"string"
        },
        "icons":{
            "$ref":"#/components/schemas/AdapterIconsRs"
        }
    }
}

Nested Schema : genericAuthSupport

Type: array

Show Source

• Array of: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SecurityPolicy"
    }
}

Nested Schema : AdapterIconsRs

Type: object

Show Source

• large-icon-url: string
• medium-gray-icon-url: string
• medium-icon-url: string
• medium-white-icon-url: string
• small-icon-url: string

{
    "type":"object",
    "properties":{
        "small-icon-url":{
            "type":"string"
        },
        "medium-icon-url":{
            "type":"string"
        },
        "large-icon-url":{
            "type":"string"
        },
        "medium-gray-icon-url":{
            "type":"string"
        },
        "medium-white-icon-url":{
            "type":"string"
        }
    }
}

Nested Schema : oAuth3LeggedSupport

Type: array

Show Source

• Array of: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/SecurityPolicy"
    }
}

Nested Schema : AdapterVendorInfo

Type: object

Show Source

• contact-us: string
• description: string
• documentation-url: string
• name: string
• release-notes: string
• support-url: string

{
    "type":"object",
    "properties":{
        "support-url":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "contact-us":{
            "type":"string"
        },
        "documentation-url":{
            "type":"string"
        },
        "release-notes":{
            "type":"string"
        }
    }
}

Nested Schema : ConnectionPropertyRs

Type: object

Show Source

• acceptable-keys: array acceptable-keys
• attachment: object ConnectionAttachmentRs
• default-property-value: string
• display-name: string
• has-attachment: boolean
• hidden-flag: boolean
• integration-role: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• property-description: string
• property-group: string
  Allowed Values: [ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ]
• property-name: string
• property-short-desc: string
• property-type: string
  Allowed Values: [ "STRING", "NUMBER", "URL", "WSDL_URL", "XSD_URL", "WADL_URL", "FILE", "PASSWORD", "URL_OR_FILE", "LIST", "MAP", "TEXT", "CHOICE", "BOOLEAN", "ARTIFACT_URL", "LIST_OF_MAPS", "CONCRETE_WSDL" ]
• property-value: string
• required-flag: boolean

{
    "type":"object",
    "properties":{
        "property-description":{
            "type":"string"
        },
        "property-short-desc":{
            "type":"string"
        },
        "acceptable-keys":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AdapterKey"
            }
        },
        "integration-role":{
            "$ref":"#/components/schemas/AdapterIntegrationRole"
        },
        "property-name":{
            "type":"string"
        },
        "property-value":{
            "type":"string"
        },
        "display-name":{
            "type":"string"
        },
        "required-flag":{
            "type":"boolean"
        },
        "hidden-flag":{
            "type":"boolean"
        },
        "property-type":{
            "$ref":"#/components/schemas/AdapterPropertyType"
        },
        "property-group":{
            "$ref":"#/components/schemas/AdapterPropertyGroup"
        },
        "attachment":{
            "$ref":"#/components/schemas/ConnectionAttachmentRs"
        },
        "has-attachment":{
            "type":"boolean"
        },
        "default-property-value":{
            "type":"string"
        }
    }
}

Nested Schema : acceptable-keys

Type: array

Show Source

• Array of: object AdapterKey

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AdapterKey"
    }
}

Nested Schema : ConnectionAttachmentRs

Type: object

Show Source

• attachment: object BaseAttachmentRs
• attachment-name: string
• property-name: string
• signature: string

{
    "type":"object",
    "properties":{
        "attachment":{
            "$ref":"#/components/schemas/BaseAttachmentRs"
        },
        "property-name":{
            "type":"string"
        },
        "attachment-name":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        }
    }
}

Nested Schema : AdapterKey

Type: object

Show Source

• display-name: string
• key-name: string
• scope: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]

{
    "type":"object",
    "properties":{
        "display-name":{
            "type":"string"
        },
        "key-name":{
            "type":"string"
        },
        "scope":{
            "$ref":"#/components/schemas/AdapterIntegrationRole"
        }
    }
}

Nested Schema : BaseAttachmentRs

Type: object

Show Source

• attachment-name: string
• content: string
• local-file-path: string
• property-name: string
• signature: string

{
    "type":"object",
    "properties":{
        "property-name":{
            "type":"string"
        },
        "attachment-name":{
            "type":"string"
        },
        "content":{
            "type":"string"
        },
        "local-file-path":{
            "type":"string"
        },
        "signature":{
            "type":"string"
        }
    }
}

Nested Schema : SecurityPolicyInfoRs

Type: object

Show Source

• scope: string
  Allowed Values: [ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ]
• security-policy: string
  Allowed Values: [ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ]
• security-properties: array security-properties

{
    "type":"object",
    "properties":{
        "scope":{
            "$ref":"#/components/schemas/IntegrationRole"
        },
        "security-policy":{
            "$ref":"#/components/schemas/SecurityPolicy"
        },
        "security-properties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ConnectionPropertyRs"
            }
        }
    }
}

Nested Schema : security-properties

Type: array

Show Source

• Array of: object ConnectionPropertyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ConnectionPropertyRs"
    }
}

Nested Schema : items

Type: array

List of Integrations

Show Source

• Array of: object IntegrationListRs

{
    "type":"array",
    "description":"List of Integrations",
    "items":{
        "$ref":"#/components/schemas/IntegrationListRs"
    }
}

Nested Schema : IntegrationListRs

Type: object

Show Source

• activation-status: string
• barta-built-by: string
  BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy
• compatible: boolean
  Compatible
• created: string (date-time)
  Created Date
• created-by: string
  Created By
• dependencies: object IntegrationDependencyRs
• description: string
  Integration Description
• doc-url: string
  Documentation URL
• end-point-uri: string
  Integration Endpoint URI
• end-points: array end-points
  Endpoints
• filmstrip: array filmstrip
  Filmstrip
• is-clone-allowed: boolean
  Flag to Check if Clone Allowed
• is-view-allowed: boolean
  Flag to Check if View Allowed
• keywords: string
  Keywords
• last-updated: string (date-time)
  Last Updated Date
• last-updated-by: string
  Last Updated By
• locked-by: string
  Locked By
• locked-date: string (date-time)
  Locked Date
• locked-flag: boolean
  Locked Flag
• mep-type: string
  MEP Type
• original-integration-code: string
  Original Integration Code
• package-name: string
  Package Name
• pattern: string
  Pattern
• pattern-description: string
  Pattern Description
• payload-tracing-enabled-flag: boolean
  Payload Tracing Enabled Flag
• percentage-complete: number
  Percentage Complete
• project-id: string
• project-type: string
  Project Type
• properties: array properties
  Integration Properties List
• proxy-wsdl: string
  Proxy WSDL
• reactivation-status: string
  Reactivation Status
• record-enabled-flag: boolean
  Record Enabled Flag
• schedule-applicable-flag: boolean
  Schedule Applicable Flag
• schedule-defined-flag: boolean
  Schedule Defined Flag
• scope: string
• smart-tags: string
  Smart Tags
• style: string
  Style
• style-description: string
  Style Description
• temp-copy-exists: boolean
  Temp Copy Exists Flag
• total-end-points: integer (int32)
• tracing-enabled-flag: boolean
  Tracing Enabled Flag
• tracking-variables: array tracking-variables
  Tracking Variables List

{
    "type":"object",
    "properties":{
        "scope":{
            "type":"string"
        },
        "description":{
            "type":"string",
            "description":"Integration Description"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "created":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "last-updated":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "end-point-uri":{
            "type":"string",
            "description":"Integration Endpoint URI"
        },
        "pattern":{
            "type":"string",
            "description":"Pattern"
        },
        "project-type":{
            "type":"string",
            "description":"Project Type"
        },
        "compatible":{
            "type":"boolean",
            "description":"Compatible"
        },
        "package-name":{
            "type":"string",
            "description":"Package Name"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "style":{
            "type":"string",
            "description":"Style"
        },
        "style-description":{
            "type":"string",
            "description":"Style Description"
        },
        "pattern-description":{
            "type":"string",
            "description":"Pattern Description"
        },
        "tracing-enabled-flag":{
            "type":"boolean",
            "description":"Tracing Enabled Flag"
        },
        "payload-tracing-enabled-flag":{
            "type":"boolean",
            "description":"Payload Tracing Enabled Flag"
        },
        "percentage-complete":{
            "type":"number",
            "description":"Percentage Complete"
        },
        "schedule-applicable-flag":{
            "type":"boolean",
            "description":"Schedule Applicable Flag"
        },
        "schedule-defined-flag":{
            "type":"boolean",
            "description":"Schedule Defined Flag"
        },
        "end-points":{
            "type":"array",
            "description":"Endpoints",
            "items":{
                "$ref":"#/components/schemas/EndPointRs"
            }
        },
        "filmstrip":{
            "type":"array",
            "description":"Filmstrip",
            "items":{
                "$ref":"#/components/schemas/FilmstripRs"
            }
        },
        "total-end-points":{
            "type":"integer",
            "format":"int32"
        },
        "record-enabled-flag":{
            "type":"boolean",
            "description":"Record Enabled Flag"
        },
        "tracking-variables":{
            "type":"array",
            "description":"Tracking Variables List",
            "items":{
                "$ref":"#/components/schemas/TrackingVariableTypeRs"
            }
        },
        "mep-type":{
            "type":"string",
            "description":"MEP Type"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "dependencies":{
            "$ref":"#/components/schemas/IntegrationDependencyRs"
        },
        "proxy-wsdl":{
            "type":"string",
            "description":"Proxy WSDL"
        },
        "keywords":{
            "type":"string",
            "description":"Keywords"
        },
        "doc-url":{
            "type":"string",
            "description":"Documentation URL"
        },
        "smart-tags":{
            "type":"string",
            "description":"Smart Tags"
        },
        "properties":{
            "type":"array",
            "description":"Integration Properties List",
            "items":{
                "$ref":"#/components/schemas/IntegrationPropRs"
            }
        },
        "barta-built-by":{
            "type":"string",
            "description":"BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy"
        },
        "is-view-allowed":{
            "type":"boolean",
            "description":"Flag to Check if View Allowed"
        },
        "is-clone-allowed":{
            "type":"boolean",
            "description":"Flag to Check if Clone Allowed"
        },
        "original-integration-code":{
            "type":"string",
            "description":"Original Integration Code"
        },
        "temp-copy-exists":{
            "type":"boolean",
            "description":"Temp Copy Exists Flag"
        },
        "reactivation-status":{
            "type":"string",
            "description":"Reactivation Status"
        },
        "project-id":{
            "type":"string"
        },
        "activation-status":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationDependencyRs

Type: object

Show Source

• certificates: array certificates
• connections: array connections
• libraries: array libraries
• lookups: array lookups

{
    "type":"object",
    "properties":{
        "connections":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.ConnectionDependencyRs"
            }
        },
        "lookups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.LookupDependencyRs"
            }
        },
        "libraries":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.LibraryDependencyRs"
            }
        },
        "certificates":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.CertificateDependencyRs"
            }
        }
    }
}

Nested Schema : end-points

Type: array

Endpoints

Show Source

• Array of: object EndPointRs

{
    "type":"array",
    "description":"Endpoints",
    "items":{
        "$ref":"#/components/schemas/EndPointRs"
    }
}

Nested Schema : filmstrip

Type: array

Filmstrip

Show Source

• Array of: object FilmstripRs

{
    "type":"array",
    "description":"Filmstrip",
    "items":{
        "$ref":"#/components/schemas/FilmstripRs"
    }
}

Nested Schema : properties

Type: array

Integration Properties List

Show Source

• Array of: object IntegrationPropRs

{
    "type":"array",
    "description":"Integration Properties List",
    "items":{
        "$ref":"#/components/schemas/IntegrationPropRs"
    }
}

Nested Schema : tracking-variables

Type: array

Tracking Variables List

Show Source

• Array of: object TrackingVariableTypeRs

{
    "type":"array",
    "description":"Tracking Variables List",
    "items":{
        "$ref":"#/components/schemas/TrackingVariableTypeRs"
    }
}

Nested Schema : certificates

Type: array

Show Source

• Array of: object IntegrationDependencyRs.CertificateDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.CertificateDependencyRs"
    }
}

Nested Schema : connections

Type: array

Show Source

• Array of: object IntegrationDependencyRs.ConnectionDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.ConnectionDependencyRs"
    }
}

Nested Schema : libraries

Type: array

Show Source

• Array of: object IntegrationDependencyRs.LibraryDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.LibraryDependencyRs"
    }
}

Nested Schema : lookups

Type: array

Show Source

• Array of: object IntegrationDependencyRs.LookupDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.LookupDependencyRs"
    }
}

Nested Schema : IntegrationDependencyRs.CertificateDependencyRs

Type: object

Show Source

• id(required): string
• name(required): string
• status(required): string
• usage(required): integer (int32)

{
    "required":[
        "id",
        "name",
        "status",
        "usage"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationDependencyRs.ConnectionDependencyRs

Type: object

Show Source

• display-name: string
• id(required): string
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• name: string
• role: string
• status: string
• type: string
• usage: integer (int32)

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "display-name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : IntegrationDependencyRs.LibraryDependencyRs

Type: object

Show Source

• code: string
• description: string
• display-name: string
• last-updated-date: string (date-time)
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• status: string
• usage: integer (int32)
• version: string

{
    "type":"object",
    "properties":{
        "display-name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "last-updated-date":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : IntegrationDependencyRs.LookupDependencyRs

Type: object

Show Source

• description(required): string
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• name(required): string
• status(required): string
• usage(required): integer (int32)

{
    "required":[
        "description",
        "name",
        "status",
        "usage"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : EndPointRs

Type: object

Show Source

• connection: object ConnectionBaseRs
• name(required): string
• role: string

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "connection":{
            "$ref":"#/components/schemas/ConnectionBaseRs"
        },
        "role":{
            "type":"string"
        }
    }
}

Nested Schema : ConnectionBaseRs

Type: object

Match All

Show Source

• allOf IdResource
• object GenericRestResource

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/IdResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        }
    ]
}

Nested Schema : FilmstripRs

Type: object

Show Source

• code(required): string
• icon-url: string
• name(required): string
• role(required): string
• status: string

{
    "required":[
        "code",
        "name",
        "role"
    ],
    "type":"object",
    "properties":{
        "icon-url":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "role":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationPropRs

Type: object

Show Source

• current-value: string
• default-value: string
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "default-value":{
            "type":"string"
        },
        "current-value":{
            "type":"string"
        }
    }
}

Nested Schema : TrackingVariableTypeRs

Type: object

Show Source

• description: string
• id: string
• message-context-ref: object TrackingVariableTypeRs.ReferenceTypeRs
• name: string
• output: object TrackingVariableTypeRs.OutputWirepointTypeRs
• primary: boolean
• property: array property
• role: string
• sub-role: string
• xpath: string

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string"
        },
        "sub-role":{
            "type":"string"
        },
        "primary":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "xpath":{
            "type":"string"
        },
        "message-context-ref":{
            "$ref":"#/components/schemas/TrackingVariableTypeRs.ReferenceTypeRs"
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs"
            }
        },
        "output":{
            "$ref":"#/components/schemas/TrackingVariableTypeRs.OutputWirepointTypeRs"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : TrackingVariableTypeRs.ReferenceTypeRs

Type: object

Show Source

• property: array property
• ref-uri: string
• role: string
• sub-role: string

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string"
        },
        "sub-role":{
            "type":"string"
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs"
            }
        },
        "ref-uri":{
            "type":"string"
        }
    }
}

Nested Schema : TrackingVariableTypeRs.OutputWirepointTypeRs

Type: object

Show Source

• message-context-ref: object TrackingVariableTypeRs.ReferenceTypeRs
• name: string

{
    "type":"object",
    "properties":{
        "message-context-ref":{
            "$ref":"#/components/schemas/TrackingVariableTypeRs.ReferenceTypeRs"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : property

Type: array

Show Source

• Array of: object TrackingVariableTypeRs.PropertyTypeRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs"
    }
}

Nested Schema : property

Type: array

Show Source

• Array of: object TrackingVariableTypeRs.PropertyTypeRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs"
    }
}

Nested Schema : TrackingVariableTypeRs.PropertyTypeRs

Type: object

Show Source

• name: string
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

List of Deployments

Show Source

• Array of: object LabelRs

{
    "type":"array",
    "description":"List of Deployments",
    "items":{
        "$ref":"#/components/schemas/LabelRs"
    }
}

Nested Schema : LabelRs

Type: object

Show Source

• code(required): string
  Deployment Identifier
• description: string
  Deployment Description
• lastUpdated: string (date-time)
  Last Updated Date
• name(required): string
  Deployment Name
• rows: array rows
  Integration List

{
    "required":[
        "name",
        "code"
    ],
    "type":"object",
    "properties":{
        "name":{
            "required":[
                "true"
            ],
            "type":"string",
            "description":"Deployment Name"
        },
        "code":{
            "required":[
                "true"
            ],
            "type":"string",
            "description":"Deployment Identifier"
        },
        "description":{
            "type":"string",
            "description":"Deployment Description"
        },
        "lastUpdated":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "rows":{
            "type":"array",
            "description":"Integration List",
            "items":{
                "$ref":"#/components/schemas/Integration"
            }
        }
    }
}

Nested Schema : rows

Type: array

Integration List

Show Source

• Array of: object Integration

{
    "type":"array",
    "description":"Integration List",
    "items":{
        "$ref":"#/components/schemas/Integration"
    }
}

Nested Schema : Integration

Type: object

Show Source

• code: string
• name: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

List of Libraries

Show Source

• Array of: object LibraryTypeRs

{
    "type":"array",
    "description":"List of Libraries",
    "items":{
        "$ref":"#/components/schemas/LibraryTypeRs"
    }
}

Nested Schema : LibraryTypeRs

Type: object

Show Source

• callout-type: string
  Callout Type
• code: string
  Library Code
• created-by: string
  Library Created By
• created-date: string (date-time)
  Library Created Date
• description: string
  Library Description
• display-name: string
  Library Name
• id: string
  Library Identifier
• last-updated-by: string
  Library Last Updated By
• last-updated-date: string (date-time)
  Library Last Updated Date
• library-type: string
  Library Type
• locked-by: string
  Locked By
• locked-date: string (date-time)
  Locked Date
• locked-flag: boolean
  Locked Flag
• project-id: string
• status: string
  Library Status
• usage: integer (int32)
  Library Usage
• version: string
  Library Version

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Library Status"
        },
        "last-updated-date":{
            "type":"string",
            "description":"Library Last Updated Date",
            "format":"date-time"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Library Last Updated By"
        },
        "created-date":{
            "type":"string",
            "description":"Library Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Library Created By"
        },
        "library-type":{
            "type":"string",
            "description":"Library Type"
        },
        "callout-type":{
            "type":"string",
            "description":"Callout Type"
        },
        "id":{
            "type":"string",
            "description":"Library Identifier"
        },
        "code":{
            "type":"string",
            "description":"Library Code"
        },
        "display-name":{
            "type":"string",
            "description":"Library Name"
        },
        "version":{
            "type":"string",
            "description":"Library Version"
        },
        "description":{
            "type":"string",
            "description":"Library Description"
        },
        "usage":{
            "type":"integer",
            "description":"Library Usage",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "project-id":{
            "type":"string"
        }
    }
}

Nested Schema : adapters

Type: array

Adapter List

Show Source

• Array of: AdapterTypeRs

{
    "type":"array",
    "description":"Adapter List",
    "items":{
        "$ref":"#/components/schemas/AdapterTypeRs"
    }
}

Nested Schema : columns

Type: array

Column List

Show Source

• Array of: string

{
    "type":"array",
    "description":"Column List",
    "items":{
        "type":"string"
    }
}

Nested Schema : rows

Type: array

Row List

Show Source

• Array of: object SuiteLookupRowData

{
    "type":"array",
    "description":"Row List",
    "items":{
        "$ref":"#/components/schemas/SuiteLookupRowData"
    }
}

Nested Schema : rows-as-array

Type: array

Show Source

• Array of: array items

{
    "type":"array",
    "items":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : SuiteLookupRowData

Type: object

Show Source

• row-data: array row-data

{
    "type":"object",
    "properties":{
        "row-data":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : row-data

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

404 Response

Project not found

500 Response

Server error

Back to Top

Examples

The following example shows how to get details about a project by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Get details about the project TEST_PROJECT

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT?integrationInstance=service-instance

Back to Top