Sign in
latestOpenAPI 3.0.12026-08-20112309904.6 KB

466169815b78

Suppliers - Management

Get detailed information about a target.

Retrieve detailed information about a target identified by system ID and target ID.

Required Permission: access_public_target

Performance impact: Low

get/public/v1/target/{systemId}/{targetId}

Path parameters

systemIdstring required

The system ID is an identifier to determine from which the targetId might originate from. Supported systemIds are "prewave", "customer", "supplier", "own".

targetIdstring required

The target ID can be the target's prewaveId or an external id (edge number) representing the site in another system.

Response

Successfully retrieved target details

idinteger required

Prewave target id

namestring required

Name of the Prewave target

snamestring nullable

Geonames Id (see https://geonames.org)

logostring nullable

URL to the logo shown in the target profile

backgroundPicturestring nullable

URL to the background picture shown in the target profile

descriptionstring nullable

Description of the Prewave target

websitestring nullable

URL to the website shown in the target profile

locationstring nullable

Location of the target

yearFoundedinteger nullable

Year the target was founded shown in the target profile

size'Small' | 'Medium' | 'Large' | 'Very large'
screenedboolean required

Whether the target is screened or not

screenedStatus'Required' | 'Pending' | 'Screened' | 'NotPossible'

Screening status of the target

linkedInIdstring nullable

LinkedIn ID of the target

monitoredSincestring date-time nullable

Date the target was monitored since

earliestAlertstring date-time nullable

Date of the earliest alert

orderinginteger nullable

Ordering of the target

disruptionStatusUpdateobject nullable

Deprecated. Disruption status has been removed and this field is always null.

ownboolean required

Whether the target is owned by user customer or not

managedboolean required

true if user is target connection contact or target is owned by user customer, false otherwise

isPublicboolean nullable

Whether the target is public or not

connectionContactsCountinteger nullable

Number of connection contacts of the target

populationinteger nullable

Population of the target. Generally applies to locations

followingboolean required

Target resides in "My follows" collection

collectionFollowingboolean required

Target resides in any followed collection (including children)

tierinteger nullable

Tier of the target (relevant when fetching Tier-N)

collectionLevelinteger nullable

How deep the target is in the collection hierarchy

scoreAvail'None' | 'Peer' | 'Alert' | 'SSA' | 'External' required
revenuenumber nullable

Revenue of the target

impact'NA' | 'No' | 'Low' | 'Mid' | 'High' | 'Critical'
mergedTargetsinteger[] required

Target ids of past targets that were merged into this current target

publicboolean

Example response

{
  "id": 102006215,
  "name": "Høyanger",
  "sname": "3191281",
  "description": "Description shown in the target profile",
  "location": "Mistelbach",
  "yearFounded": 1999,
  "screened": true,
  "screenedStatus": "Screened",
  "linkedInId": "general-motors",
  "ctype": {
    "id": 1234,
    "ctype": "mine",
    "targetTypeId": 1234,
    "displayName": "Mine",
    "pluralName": "Mines",
    "icon": "fas fa-mine",
    "bgColor": "#ff0000",
    "textColor": "#ffffff"
  },
  "foreignSystems": [
    {
      "id": "1234",
      "source": "SAP_ARIBA"
    }
  ]
}