Cloud APIs
/
Opportunity Assessor
/
/ProspectAnalysis

ProspectAnalysis

Prospect analysis management.

Operations

Search for prospect analysis by name

Request

Returns a list of prospect analyses that fit the search criteria. The results are paginated.

Security
bearer and appkey
Query
AnalysisNamestring

Prospect analysis name

ProspectNamestring

Prospect folder name

Offsetinteger, (int32)

How many analyses to skip in the result, default is 0

Default:0
Limitinteger, (int32)

Maximum number of analyses to return, default is 200, maximum is 2000

Default:200
Headers
slb-contract-idstring^[a-zA-Z0-9_-]+$required

Delfi Contract ID

Example:My-contract-ID
curl -i -X GET \
  'https://eu-api.delfi.slb.com/spar/assessments/v1/prospectanalysis?AnalysisName=string&ProspectName=string&Offset=0&Limit=200' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'appkey: YOUR_API_KEY_HERE' \
  -H 'slb-contract-id: My-contract-ID'

Responses

OK

Body
analysesArray of objects(ProspectAnalysisInfoDto)

The prospect analyses contained in the search result.

paginationobject(PaginationDto)

Result pagination

Response
{
  "analyses": [
    {
      "analysisName": "string",
      "analysisId": 0,
      "analysisPath": "string",
      "prospect": {
        "name": "string",
        "id": 0,
        "parentId": 0
      },
      "plays": [
        {
          "name": "string",
          "id": 0,
          "parentId": 0
        }
      ],
      "basins": [
        {
          "name": "string",
          "id": 0,
          "parentId": 0
        }
      ],
      "createdDate": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "createdByRealName": "string",
      "lastModifiedDate": "2019-08-24T14:15:22Z",
      "lastModifiedBy": "string",
      "lastModifiedByRealName": "string",
      "status": "Approved",
      "isExternal": true
    }
  ],
  "pagination": {
    "next": "string",
    "self": "string"
  }
}