Web Service Method: Create Project Snapshot

Description

Create a snapshot of a PoolParty project.

Note

When data of a project is changed via API, you should have a mechanism that uses the snapshot service to create a consistent state of the project. Find details on the Snapshot dashboard here: The Snapshot Dashboard

If you change the data of a project programmatically but not use the snapshot method, users that log into PoolParty will see an alert message, saying that the data in the project might be outdated or corrupt. To find out how to bring your project back to normal snapshot behavior please refer to this topic: View and Restore Automatically Generated Snapshots

Best Practice

It is not necessary to use the snapshot service after each small project change.

Example: you have a script that adds multiple alternative labels to concepts in one run. In this case it does not make sense to fire a snapshot after each altLabel input. You should perform the snapshot as soon as all changes have been performed by the script.

URL: /PoolParty/api/projects/{project}/snapshot

Request

Supported Methods

GET

POST

Path Variables

Variable

Comment

{project}

The UUID or the URI supplement (textual identifier) of the project to be used.

HTTP Parameters

Parameter

Comment

Type

Required

system

Create a system snapshot.

Default = false.

Note

Using the snapshot service with the default parameter (system=false) is the equivalent to the the PoolParty frontend functionality Create Snapshots Manually

The user that triggers the service is the creator of the snapshot. This is called a 'manual snapshot'.

boolean

false

note

Provide a note that is visible in the Snapshot dashboard

String

false

Response

json formatted response message

Request Pattern

http://<server-url>/PoolParty/api/projects/{project}/snapshot

Examples

Example Request

http://vocabulary.semantic-web.at/PoolParty/api/projects/1DCE0ED2-D7E8-0001-86A1-18652DF0D7A0/snapshot

Example Response

{
  success: true,
  message: "Repository snapshot successfully generated"
}
23901062.png