Activity Types
Type | Description |
---|---|
UNDEFINED | (Default) The user has not specified details for the Activity |
MANUAL | The user manually generated the wasGeneratedBy entities of this Activity |
CODE EXECUTION | The user executed code that generated the wasGeneratedBy entities of this Activity |
Current Entity API
The following table describes how provenance effects the current Entity CRUD API:
URL | HTTP Type | Description |
---|---|---|
/entity?activityId={activity id} | POST | Create a new entity and links it to the provided activity. |
/entity/{id}?activityId={activity id} | PUT | Updates the entity and links the current version of the entity to the provided activity. |
/entity/{id}/version?activityId={activityId} | POST | Creates a new version of a given version-able entity and links it to the provided activity. |
/entity/{id}/activity | GET | Returns the activity that generated (aka links to) the current version of the specified entity. |
/entity/{id}/version/{versionNumber}/activity | GET | Returns the activity that generated (aka links to) the specific version of the entity. |
OR
The following table describes how provenance effects the current Entity CRUD API:
URL | HTTP Type | Description |
---|---|---|
/entity/{id}/activity | POST | Creates a new activity and links it to this entity. |
/entity/{id}/activity | PUT | Links the activity to this entity. |
/entity/{id}/version/activity | POST | Creates a new activity and links it to this version of the entity |
/entity/{id}/version/activity | PUT | Links the activity to this version of the entity |
/entity/{id}/activity | GET | Returns the activity linked to the current version of the specified entity. |
/entity/{id}/version/{versionNumber}/activity | GET | Returns the activity linked to this specific version of the entity. |
Provenance Additions to the API
The following table describes the new methods for manipulating the versions of a version-able entity.
URL | HTTP Type | Description |
---|---|---|
/activity | POST | Creates a new activity object. |
/activity/{activityId} | PUT | Updates the specified activity. Only the creator of an activity may update it. |
/activity/{activityId} | GET | Returns the specified activity. READ access is permitted if you can see a single entity that was generated by (aka links to) this activity. |
/activity/{activityId} | DELETE | Delete the specified activity. Only the creator of an activity may delete it. |