Roles
Assign roles to actors on a resource.
The Role object
object
string
id
string
Unique identifier for the object.
created_at
date-time
ISO 8601 timestamp of when the object was created.
updated_at
date-time
ISO 8601 timestamp of when the object was last updated.
name
string
The name of the role.
description
The description of the role.
resource_type
string
permissions
array
Create a role
Create a role for the resource type within the space
POST
/v1/core/roles
Returns TODO
TBD
Retrieve a role
Retrieve a role by its ID
GET
/v1/core/roles/:role_id
Path Params
role_id
string
(required)
Unique identifier for the object.
Returns TODO
TBD
List roles
List all roles for the resource type within the space
GET
/v1/core/roles
Returns TODO
TBD
Update a role
Update a role by its ID
PUT
/v1/core/roles/:role_id
Path Params
role_id
string
(required)
Unique identifier for the object.
Returns TODO
TBD
Delete a role
Delete a role by its ID
DELETE
/v1/core/roles/:role_id
Path Params
role_id
string
(required)
Unique identifier for the object.
Returns TODO
TBD
Socras
A Socra is an atomic unit of progress.
The Socra object
object
string
id
string
Unique identifier for the object.
created_at
date-time
ISO 8601 timestamp of when the object was created.
updated_at
date-time
ISO 8601 timestamp of when the object was last updated.
journey
string
Unique identifier for the object.
originator
string
Unique identifier for the object.
title
string
assignee
status
priority
description
due_at
Create a Socra
Create a Socra for the journey
POST
/v1/core/socras
Returns TODO
TBD
List Socras
List all Socras for the journey
GET
/v1/core/socras
Returns TODO
TBD
Retrieve a Socra
Retrieve a Socra by its ID
GET
/v1/core/socras/:id
Path Params
id
string
(required)
Unique identifier for the object.
Returns TODO
TBD
Update a Socra
Update a Socra by its ID
PUT
/v1/core/socras/:id
Path Params
id
string
(required)
Unique identifier for the object.
Returns TODO
TBD
Delete a Socra
Delete a Socra by its ID
DELETE
/v1/core/socras/:id
Path Params
id
string
(required)
Unique identifier for the object.
Returns TODO
TBD
Journeys
A Journey is a container for Socras.
The Journey object
object
string
id
string
Unique identifier for the object.
created_at
date-time
ISO 8601 timestamp of when the object was created.
updated_at
date-time
ISO 8601 timestamp of when the object was last updated.
owner
string
Unique identifier for the object.
parent
name
string
description
string
active
boolean
Create a Journey
Create a Journey
POST
/v1/core/journeys
Returns TODO
TBD
Retrieve a Journey
Retrieve a Journey by its ID
GET
/v1/core/journeys/:id
Path Params
id
string
(required)
Unique identifier for the object.
Returns TODO
TBD
List Journeys
List all Journeys
GET
/v1/core/journeys
Returns TODO
TBD
Update a Journey
Update a Journey by its ID
PUT
/v1/core/journeys/:id
Path Params
id
string
(required)
Unique identifier for the object.
Returns TODO
TBD
Delete a Journey
Delete a Journey by its ID
DELETE
/v1/core/journeys/:id
Path Params
id
string
(required)
Unique identifier for the object.
Returns TODO
TBD