Chilkat Online Tools

DataFlex / Cognite API v1 / Create label definitions.

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    // The following JSON is sent in the request body.

    // {
    //   "items": [
    //     {
    //       "externalId": "voluptate in culpa in",
    //       "name": "dolor fugiat",
    //       "description": "fugiat est pariatur",
    //       "dataSetId": 4122069480134880
    //     },
    //     {
    //       "externalId": "Duis",
    //       "name": "aliqua mollit reprehenderit cillum laboris",
    //       "description": "occaecat anim enim quis Ut",
    //       "dataSetId": 1790157494961090
    //     }
    //   ]
    // }

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateString Of hoJson "items[0].externalId" "voluptate in culpa in" To iSuccess
    Get ComUpdateString Of hoJson "items[0].name" "dolor fugiat" To iSuccess
    Get ComUpdateString Of hoJson "items[0].description" "fugiat est pariatur" To iSuccess
    Get ComUpdateInt Of hoJson "items[0].dataSetId" 123 To iSuccess
    Get ComUpdateString Of hoJson "items[1].externalId" "Duis" To iSuccess
    Get ComUpdateString Of hoJson "items[1].name" "aliqua mollit reprehenderit cillum laboris" To iSuccess
    Get ComUpdateString Of hoJson "items[1].description" "occaecat anim enim quis Ut" To iSuccess
    Get ComUpdateInt Of hoJson "items[1].dataSetId" 123 To iSuccess

    Send ComSetRequestHeader To hoHttp "content-type" "application/json"
    Send ComSetRequestHeader To hoHttp "api-key" "{{api-key}}"

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoJson to vJson
    Get pvComObject of hoResp to vResp
    Get ComHttpJson Of hoHttp "POST" "https://domain.com/api/v1/projects/{{project}}/labels" vJson "application/json" vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1


End_Procedure

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "voluptate in culpa in",
            "name": "dolor fugiat",
            "description": "fugiat est pariatur",
            "dataSetId": 4122069480134880
        },
        {
            "externalId": "Duis",
            "name": "aliqua mollit reprehenderit cillum laboris",
            "description": "occaecat anim enim quis Ut",
            "dataSetId": 1790157494961090
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/labels

Postman Collection Item JSON

{
  "id": "createLabelDefinitions",
  "name": "Create label definitions.",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "labels"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "description": "Creates label definitions that can be used across different resource types. The label definitions are uniquely identified by their external id.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"voluptate in culpa in\",\n            \"name\": \"dolor fugiat\",\n            \"description\": \"fugiat est pariatur\",\n            \"dataSetId\": 4122069480134880\n        },\n        {\n            \"externalId\": \"Duis\",\n            \"name\": \"aliqua mollit reprehenderit cillum laboris\",\n            \"description\": \"occaecat anim enim quis Ut\",\n            \"dataSetId\": 1790157494961090\n        }\n    ]\n}"
    }
  }
}