Versions Compared

Key

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

...

URL

HTTP Type

Description

/entity?generatedBy={activity id}POST

Creates a new entity and creates a generatedBy connection to the provided activity.

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

Updates the entity and creates a generatedBy connection from the current version of the entity to the provided activity. Set activity id to -1 to delete generatedBy connection.

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

Creates a new version of a given version-able entity and creates a generatedBy connection to the provided activity. Set activity id to -1 to delete generatedBy connection.

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

Creates a new EntityBundle and creates a generatedBy connection to the provided activity. Set activity id to -1 to delete generatedBy connection.

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

Updates an EntityBundle and creates a generatedBy connection to the provided activity. Set activity id to -1 to delete generatedBy connection.

  • Error Codes
    • 403 - Unauthorized assignment of activity. You must be the creator of the activity to connect it to an entity
    • 404 - If activityId is not found.

...

The following table describes the new methods for performing CRUD on Activity objects.

Paginated service to get all Activities (that you can see)

URL

HTTP Type

Description

/activityGET

/activityPOST

Creates a new activity object.

/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 this activity.
    • 404 - If activityId is not found.
/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}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.