Skip to main content
GET
Get Service

Authorizations

api_key
string
header
required

Query Parameters

oId
string
required

Service OId

Response

Service data

_metadata
object
required
oId
string
required

The ID of the service

Minimum string length: 1
Example:

"p_1234"

createdAt
string<date-time>
required

The date and time the service was created

Example:

"2021-01-01"

data
object
required
user
object
required
workspace
object
required
updatedAt
string<date-time> | null

The date and time the service was updated

Example:

"2021-01-01"

archivedAt
string<date-time> | null

The date and time the service was archived

Example:

"2021-01-01"

deletedAt
string<date-time> | null

The date and time the service was deleted

Example:

"2021-01-01"

name
string | null

The external facing name of the service

Example:

"Service Name"

internalName
string | null

The internal name of the service

Example:

"Service Internal Name"

description
string | null

The description of the service

Example:

"Service Description"

primaryUrl
string | null

The primary URL of the service

Example:

"https://www.service.com"

releaseNotesUrls
string[] | null

Watched release-notes pages for this service; Octave re-reads each on a schedule and proposes library updates from what shipped

Maximum array length: 5
Example:
active
boolean
default:true

Whether the service is active and can be used

Example:

true

qualifyingQuestions
object[] | null