Create a Snapshot
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots
Request
- application/x-www-form-urlencoded
-
projectId(required): string
The project ID
-
spaceId(required): string
The space ID
-
snapshotDescription: string
The snapshot description
-
snapshotName: string
The snapshot Name
Response
- application/json
- application/xml;qs=0.9
200 Response
object
201 Response
400 Response
401 Response
403 Response
404 Response
409 Response
500 Response
Examples
The following example shows how to create a snapshot in a space by submitting a POST request on the REST resource.
curl -X POST --header 'Content-Type: application/x-www-form-urlencoded' --header 'Accept: application/json' -H "Authorization: Bearer access_token' -d 'snapshotName=Snapshot1' -d 'snapshotDescription=This is my new snapshot' 'http://example.com:7001/ic/api/process/v1/spaces/<spaceId>/projects/<projectId>/snapshots'
Where,
-
example.com
is the host where Oracle Integration is running. -
<version> is the REST API version.
-
Content-Type
:application/x-www-form-urlencoded
-
Request URL
:http://example.com:7001/ic/api/process/<version>/spaces/<spaceId>/projects/<projectId>/snapshots
-
<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
The following shows the required request parameters to create a snapshot. You need to provide application/x-www-form-urlencoded
parameter to create a snapshot.
-
snapshotName
: Specifies the name of the snapshot, for exampleMySnapshot
-
description
: Specifies the description of the snapshot.
Example of Response Header
Status Code: 201 created Date: Mon, 03 Apr 2017 09:39:39 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" } ] }