Get a deliverable

Request

Returns the full detail of a single deliverable, including its assigned data source, status, contributors, approvers, and due date. Requires the owning studyId alongside the deliverableId.

Security

bearer and appkey

Path

deliverableIdstringrequired

The ID of the deliverable to get.

Query

studyIdstringrequired

The study which the deliverable belongs to.

slb-partition-idstringrequired

Data partition id.

curl -i -X GET \
  'https://api.delfi.slb.com/fdplan/studies/v1/deliverables/{deliverableId}?studyId=string' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-partition-id: string'

Responses

Deliverable retrieved successfully.

Bodyapplication/json

idstringrequired

Deliverable's unique identifier.

Example:"01CKXHZPAEERP06F3CNKBAPE0F"

titlestring

The title of the deliverable.

Example:"Decline Curves"

descriptionstring

The description of this deliverable.

Example:"Decline curves for Robin field."

statusstring

The status of the deliverable.

Enum:"New""Requested""In Progress""Pending Approval""Approved"

Example:"Requested"

attachmentTypestring

The FDPlan data-type ID for this deliverable's attachment.

Example:"decline-curves"

attachmentTypeVersioninteger

The FDPlan data-type version for this deliverable's attachment.

Example:1

attachmentSpecAddressobject(SpecAddress)

An address used to describe the location of a Spec within a WorkflowSpec. Used to enrich the spec model with additional attributes such as specifying the location of a data container or providing annotations.

attachmentstring

The relative URI to the deliverable's attachment. May be empty indicating that the deliverable has no attachment. NOTE: This field is deprecated in favour of dataSource.

associatedScenarioIdstring

The ID of the scenario associated with this deliverable.

Example:"01CKXHZPAEERP06F3CNKBAPE0F"

contributorsArray of strings

A list of the IDs of users marked as contributing to this deliverable.

Example:

[
  "user1@slb.com",
  "user2@slb.com"
]

approversArray of strings

A list of the IDs of users marked as approvers for this deliverable.

Example:

[
  "user3@slb.com"
]

dueDatestring or null, (date-time)

The date by which the deliverable must be Approved

Example:"2020-09-08T09:53:36.000Z"

lastUpdatedobject(LastUpdated)

Details of the last update to a resource.

Example:

{
  "atDate": "2020-09-08T09:53:36.000Z",
  "byEvent": "01EHPJ54HEA77K95T5KPH5JSW9",
  "byUser": "user@slb.com"
}

attachmentLastUpdatedobject(LastUpdated)

Details of the last update to a resource.

Example:

{
  "atDate": "2020-09-08T09:53:36.000Z",
  "byEvent": "01EHPJ54HEA77K95T5KPH5JSW9",
  "byUser": "user@slb.com"
}

dataSourceobject(VersionId)

A versioned resource identifier.

Example:

{
  "id": "01CP3E6EJJ25J29YHZ0K4RDZH8",
  "version": 1
}

Response

{
  "id": "01CKXHZPAEERP06F3CNKBAPE0F",
  "title": "title",
  "description": "Decline curves for Robin field.",
  "status": "Requested",
  "attachmentType": "decline-curves",
  "attachmentTypeVersion": 1
}