Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

URL

HTTP Type

Description

/entity?activityId={activity id}POSTCreate

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.

/entity/{id}/activityGETReturns the activity that generated (aka links to) the current version of the specified entity
  • 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/{versionNumber}/activityGET

Returns the activity that generated (aka links to) the

specific

current version of the specified 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
  • Error Codes
    • 404 - If the entity is not linked to an activity.
/entity/{id}/version/activityPOSTCreates a new activity and links it to this version of the entity/entity/{idversionNumber}/version/activityPUTLinks the activity to this version of the entity/entity/{id}/activityGET

Returns the activity

linked

that generated (aka links to) the

current

specific version of the

specified

entity.

/entity/{id}/version/{versionNumber}/activityGETReturns the activity linked to this specific
  • Error Codes
    • 404 - If that version of the entity is not linked to an activity.
Provenance Additions to the API

...

URL

HTTP Type

Description

/activityPOST

Creates a new activity object.

/activity/{activityId}PUT

Updates the specified activity.

Only

  • Error Codes
    • 403 - Unauthorized update of activity. You must be the creator of
an
    • the activity
may update
    • 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}DELETEDelete the specified activity. Only
  • Error Codes
    • 403 - Unauthorized delete of activity. You must be the creator of
an
    • the activity
may delete it
    • to modify it.
    • 404 - If activityId is not found.