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 7 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}POST

Creates a new entity and links it to the provided activity.

  • Error Codes
    • 403 - Unauthorized assignment of activity. You must be the creator of the activity to link it to an entity
    • 404 - If activityId is not found.
/entity/{id}?activityId={activity id}PUT

Updates the entity and links the current version of the entity to the provided activity.

  • Error Codes
    • 403 - Unauthorized assignment of activity. You must be the creator of the activity to link it to an entity
    • 404 - If activityId is not found.
/entity/{id}/version?activityId={activityId}POST

Creates a new version of a given version-able entity and links it to the provided activity.

  • Error Codes
    • 403 - Unauthorized assignment of activity. You must be the creator of the activity to link it to an entity
    • 404 - If activityId is not found.
/entity/{id}/activityGET

Returns the activity that generated (aka links to) the current version of the specified entity.

  • Error Codes
    • 404 - If the entity is not linked to an activity.
/entity/{id}/version/{versionNumber}/activityGET

Returns the activity that generated (aka links to) the specific version of the entity.

  • Error Codes
    • 404 - If that version of the entity is not linked to an activity.
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}PUT

Updates the specified activity.

  • Error Codes
    • 403 - Unauthorized update of activity. You must be the creator of the activity to modify it.
    • 404 - If activityId is not found.
/activity/{activityId}GET

Returns the specified activity.

  • Error Codes
    • 403 - Unauthorized access of activity. READ access is permitted if you can see a single entity that was generated by (aka links to) this activity.
    • 404 - If activityId is not found.
/activity/{activityId}DELETE
  • Error Codes
    • 403 - Unauthorized delete of activity. You must be the creator of the activity to modify it.
    • 404 - If activityId is not found.
  • No labels