Jump to

• Request
• Response
• Examples

Retrieve Usage of the Lookup

get

/ic/api/integration/v1/lookups/{name}/usage

Lists all the integrations which use the specified lookup.

Request

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• name(required): string
  Lookup name.

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root Schema : UsageRs

Type: object

Show Source

• connectionUsage: array connectionUsage
• integrationUsage: array integrationUsage
• links: array links
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "integrationUsage":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntegrationUsageRs"
            }
        },
        "connectionUsage":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ConnectionUsageRs"
            }
        }
    }
}

Nested Schema : connectionUsage

Type: array

Show Source

• Array of: object connectionUsage

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

Nested Schema : integrationUsage

Type: array

Show Source

• Array of: object integrationUsage

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

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : connectionUsage

Type: object

Show Source

• links: array links
• name: string
• status: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    },
    "xml":{
        "name":"connectionUsage"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : integrationUsage

Type: object

Show Source

• code: string
• isLocked: boolean
  Default Value: false
• links: array links
• name: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "isLocked":{
            "type":"boolean",
            "default":false
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        }
    },
    "xml":{
        "name":"integrationUsage"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

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

404 Response

Lookup not found

412 Response

Precondition failed

500 Response

Server error

Back to Top

Examples

The following example shows how to get the list of integrations which use the specified lookup 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 integrations used by the lookup testLookup

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/lookups/testLookup/usage

Back to Top