Skip to main content
GET
Open and then return the Record.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

recordId
string
required

The ID of the Record to open.

Query Parameters

withUserGroups
boolean

When true, include the Record's User Groups in the response.

Response

OK

id
string
required
active
boolean
required
created
string<date-time>
required
updated
string<date-time>
required
state
enum<string>
required
Available options:
ARCHIVED,
LIVE
sequenceId
integer<int64>
required
dueDate
string<date-time>
required
stepDueDate
string<date-time>
required
userDate
string<date-time>
required
activeDate
string<date-time>
required
enteredStepDate
string<date-time>
required
completedDate
string<date-time>
required
lastCompletedDate
string<date-time>
required
recordName
string
required
step
object
required

An entity to store details about a specific step within a workflow

origin
object
required

An entity to store details about a specific step within a workflow

creator
object
required

Entity for storing all information pertaining to a user.

user
object
required

Entity for storing all information pertaining to a user.

secondaryAssignees
object[]
required

Entity for storing all information pertaining to a user.

userGroups
object[]
required
currentValueMaps
object[]
required
assignee
object
required

Entity for storing all information pertaining to a user.

assigneeType
enum<string>
required
Available options:
EXTERNAL,
INTERNAL,
NONE,
SELF,
STEP
daysUntilDue
object
required

A summary of the days left until a record is due.

activeForRecord
any
required

Circular reference to Record_FullRecordSummary

lastUpdated
string<date-time>
required
status
enum<string>
Available options:
INACTIVE,
NOT_ASSIGNED,
ASSIGNED,
IN_PROGRESS,
COMPLETE
workflow
object

An entity that contains information about a set of steps within a particular application.

viewableTitle
string
initialStateEndStep
boolean
workflowDueDate
string<date-time>
recordType
enum<string>
Available options:
RECORD,
JIRA_RECORD
name
string
isPublic
boolean