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

Path Parameters

• name(required): string
  Lookup name

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.resource+json,type=singular

200 Response

Successful operation

Body ()

Root Schema : UsageRs

Type: object

Show Source

• connection-usage: array connection-usage
  Connection Usage List
• integration-usage: array integration-usage
  Integration Usage List
• links: array links
  Suite Link List
• name: string
  Resource Name
• project-id: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Resource Name"
        },
        "links":{
            "type":"array",
            "description":"Suite Link List",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        },
        "integration-usage":{
            "type":"array",
            "description":"Integration Usage List",
            "items":{
                "$ref":"#/components/schemas/IntegrationUsageRs"
            }
        },
        "connection-usage":{
            "type":"array",
            "description":"Connection Usage List",
            "items":{
                "$ref":"#/components/schemas/ConnectionUsageRs"
            }
        },
        "project-id":{
            "type":"string"
        }
    }
}

Nested Schema : connection-usage

Type: array

Connection Usage List

Show Source

• Array of: object ConnectionUsageRs

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

Nested Schema : integration-usage

Type: array

Integration Usage List

Show Source

• Array of: object IntegrationUsageRs

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

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

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":"#/components/schemas/SuiteLink"
            }
        }
    }
}

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

Type: object

Show Source

• code: string
• is-locked: boolean
• links: array links
• name: string
• reactivation-status: string
• status: string
• version: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SuiteLink"
            }
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "is-locked":{
            "type":"boolean"
        },
        "reactivation-status":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/lookups/testLookup/usage?integrationInstance=service-instance

Back to Top