Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
DevOps Components

Get a Component by ID

Retrieve the currently stored Component data for the given ID.

The result will be what is currently stored, ignoring any pending updates or deletes.

Only Connect apps that define the jiraDevOpsComponentProvider module can access this resource. This resource requires the 'READ' scope for Connect apps.

get/rest/devopscomponents/1.0/devopscomponents/{componentId}

Path parameters

componentIdstring required

The ID of the Component to fetch.

Response

The Component data currently stored for the given ID.

schemaVersion'1.0' required

The DevOpsComponentData schema version used for this devops component data.

Placeholder to support potential schema changes in the future.

idstring required

The identifier for the DevOps Component. Must be unique for a given Provider.

updateSequenceNumberinteger required

An ID used to apply an ordering to updates for this DevOps Component in the case of out-of-order receipt of update requests.

This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the Provider system, but other alternatives are valid (e.g. a Provider could store a counter against each DevOps Component and increment that on each update to Jira).

Updates for a DevOps Component that are received with an updateSqeuenceId lower than what is currently stored will be ignored.

namestring required

The human-readable name for the DevOps Component. Will be shown in the UI.

providerNamestring

The human-readable name for the Provider that owns this DevOps Component. Will be shown in the UI.

descriptionstring required

A description of the DevOps Component in Markdown format. Will be shown in the UI.

urlstring uri required

A URL users can use to link to a summary view of this devops component, if appropriate.

This could be any location that makes sense in the Provider system (e.g. if the summary information comes from a specific project, it might make sense to link the user to the component in that project).

avatarUrlstring uri required

A URL to display a logo representing this devops component, if available.

tier'Tier 1' | 'Tier 2' | 'Tier 3' | 'Tier 4' required

The tier of the component. Will be shown in the UI.

componentType'Service' | 'Application' | 'Library' | 'Capability' | 'Cloud resource' | 'Data pipeline' | 'Machine learning model' | 'UI element' | 'Website' | 'Other' required

The type of the component. Will be shown in the UI.

lastUpdatedstring date-time required

The last-updated timestamp to present to the user the last time the DevOps Component was updated.

Expected format is an RFC3339 formatted string.

Example response

{
  "schemaVersion": "1.0",
  "id": "111-222-333",
  "updateSequenceNumber": 1523494301448,
  "name": "Galactus",
  "providerName": "Marvel",
  "url": "https://example.com/project/MS/galactus/summary",
  "avatarUrl": "https://example.com/project/MS/galactus/logo",
  "tier": "Tier 1",
  "componentType": "Service",
  "lastUpdated": "2018-01-20T23:27:25.000Z"
}