Postman

We recommend that you download, install and use Postman to test Cognite API requests and examine responses.

In Postman:

Click Import > Import From Link and enter a URL to import one of our Postman collections:

API version	API Status	Postman collection link
API v1	Stable	Recommended for production environments. `https://storage.googleapis.com/cognite-postman-collections/v1.json`
API 0.5	Deprecated	`https://storage.googleapis.com/cognite-postman-collections/0.5.json`
Playground	Unstable	`https://storage.googleapis.com/cognite-postman-collections/playground.json`

Set the api-key and project environment variables. The api-key is injected as the header to authenticate your requests, and the project routes all your requests to the correct project in Cognite Data Fusion. To set the environment variables:
1. Click the button in the top-right corner, click Add and enter an Environment Name, for example cognite-publicdata.
2. Under VARIABLE, enter api-key, and in the CURRENT_VALUE field enter your API key.
3. Add another VARIABLE, name it project, and in the CURRENT_VALUE field enter the name of your project.
  
  If you got your API key from the Open Industrial Data Project, enter publicdata as the name of the project.
4. Click Add to create the environment.
5. If necessary, select your newly created environment in the dropdown menu in the top right corner.
Make a test API request to check that your integration is working correctly:
1. Click the Cognite API collection in the left-hand menu, and select Assets > List all assets.
2. Click Send.

Cognite Data Fusion returns a list of all asset objects in response to your API request. For the Open Industrial Data project the JSON results look similar to this:

{
    "nextCursor": "8ZiApWzGe5RnTAE1N5SABLDNv7GKkUGiVUyUjzNsDvM",
    "items": [
        {
            "name": "23-TE-96116-04",
            "parentId": 3117826349444493,
            "description": "VRD - PH 1STSTGGEAR THRUST BRG OUT",
            "metadata": {
                "ELC_STATUS_ID": "1211",
                "RES_ID": "525283",
                "SOURCE_DB": "workmate",
                "SOURCE_TABLE": "wmate_dba.wmt_tag",
                "WMT_AREA_ID": "1600",
                "WMT_CATEGORY_ID": "1116",
                "WMT_CONTRACTOR_ID": "1686",
                "WMT_FUNC_CODE_ID": "4564",
                "WMT_LOCATION_ID": "1004",
                "WMT_PO_ID": "8309",
                "WMT_SAFETYCRITICALELEMENT_ID": "1060",
                "WMT_SYSTEM_ID": "4440",
                "WMT_TAG_CREATED_DATE": "2009-06-26 15:36:37",
                "WMT_TAG_CRITICALLINE": "N",
                "WMT_TAG_DESC": "VRD - PH 1STSTGGEAR THRUST BRG OUT",
                "WMT_TAG_GLOBALID": "1000000000681024",
                "WMT_TAG_HISTORYREQUIRED": "Y",
                "WMT_TAG_ID": "346434",
                "WMT_TAG_ID_ANCESTOR": "345637",
                "WMT_TAG_ISACTIVE": "1",
                "WMT_TAG_ISOWNEDBYPROJECT": "0",
                "WMT_TAG_LOOP": "96116",
                "WMT_TAG_MAINID": "681760",
                "WMT_TAG_NAME": "23-TE-96116-04",
                "WMT_TAG_UPDATED_BY": "8137",
                "WMT_TAG_UPDATED_DATE": "2014-07-11 09:25:15"
            },
            "id": 702630644612,
            "createdTime": 0,
            "lastUpdatedTime": 0,
            "rootId": 6687602007296940
        },
...

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

Once you have successfully made an API request, you’re ready to begin interacting with the Cognite Data Fusion API through our Software Development Kits (SDKs).

# Postman

Postman