REST API for Oracle Integration

Retrieve a Snapshot by ID

get

/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots/{snapshotId}

Retrieves the details of the snapshot based on the specified snapshot ID.

Request

Path Parameters

projectId(required): string

The project ID
snapshotId(required): string

The snapshot ID
spaceId(required): string

The space ID

Response

Supported Media Types

application/json
application/xml;qs=0.9

200 Response

Success. Retrieve snapshot.

Root Schema : snapshot

Type: object

the representation of a design time snapshot created from a project

401 Response

Unauthorized

404 Response

Space/Project/Snapshot not found.

500 Response

Error in retrieving snapshot

Examples

The following example shows how to retrieve details of a snapshot by submitting a GET request on the REST resource.

Send Request

The following example shows the contents of the send request:

https://example.com/ic/api/process/<version>/spaces/<spaceId>/projects/<projectId>/snapshots/<snapshotId>

Where,

example.com is the host where Oracle Integration is running.
<version> is the REST API version.
<spaceId> is the unique ID for a space. To retrieve available spaces, see Retrieve Spaces.
<projectId> is the unique ID for a project. To retrieve available projects, see Retrieve projects

Example of Response Header

Status Code: 200 OK
Date:  Tue, 21 Mar 2017 08:39:54 GMT
Content-Type:  application/json

Example of Response Body

{
  "id": "Snapshot1",
  "description": "This is my Snapshot",
  "creator": "jsmith",
  "creation": "2017-04-03,03:21:19 PDT",
  "links": [
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/New%20Project/snapshots/Snapshot1",
      "rel": "self"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/New%20Project/snapshots/Snapshot1",
      "rel": "canonical"
    },
    {
      "href": "http://example.com:7001/ic/api/process/v1/spaces/46423b0a-a6a1-4748-b677-e8160bf50ce9/projects/New%20Project",
      "rel": "parent"
    }
  ]
}