Jump to

• Request
• Response
• Examples

Export a Lookup

get

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

Exports a lookup. This operation returns a byte stream that is output to the display by default. If you are using cURL, use the -o option to save the response to a file.

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/octet-stream

200 Response

Successful operation

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: string

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

404 Response

Lookup not found

423 Response

Lookup is in locked status

500 Response

Server error

Back to Top

Examples

The following example shows how to export a lookup to a specified file 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: Export a lookup

This command downloads the lookup to the specified file myfile.csv in the same directory from which the command was run.

curl -X GET -H 'Authorization: Bearer access_token' -o 'myfile.csv' https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/lookups/myLookup/archive?integrationInstance=service-instance

Required options for this cURL request:

• -o '/path/myfile.csv': Location and name of the file in which to export the lookup.

Back to Top