Skip to end of banner
Go to start of banner

Provenance API

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Activity Types
TypeDescription
UNDEFINED(Default) The user has not specified details for the Activity
MANUAL

The user manually generated the wasGeneratedBy entities of this Activity

CODE EXECUTIONThe 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}POSTCreate a new entity and links it to the provided activity.
/entity/{id}?activityId={activity id}PUTUpdates the entity and links the current version of the entity to the provided activity.
/entity/{id}/version?activityId={activityId}POSTCreates a new version of a given version-able entity and links it to the provided activity.
/entity/{id}/activityGETReturns the activity that generated (aka links to) the current version of the specified entity.
/entity/{id}/version/{versionNumber}/activityGETReturns 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}/activityPOSTCreates a new activity and links it to this entity.
/entity/{id}/activityPUTLinks the activity to this entity.
/entity/{id}/version/activityPOSTCreates a new activity and links it to this version of the entity
/entity/{id}/version/activityPUTLinks the activity to this version of the entity
/entity/{id}/activityGETReturns the activity linked to the current version of the specified entity.
/entity/{id}/version/{versionNumber}/activityGETReturns 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

/activityPOST

Creates a new activity object.

/activity/{activityId}PUTUpdates the specified activity. Only the creator of an activity may update it.
/activity/{activityId}GETReturns 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}DELETEDelete the specified activity. Only the creator of an activity may delete it.
  • No labels