GET /api/v2/assets/:asset_id/custom_fields
Returns custom fields for asset

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

GET /api/v2/assets/_I2vT3wBW4fR4Me2cHzE/custom_fields
200
{
  "id": "_I2vT3wBW4fR4Me2cHzE",
  "custom_fields": {
    "17": [
      {
        "6": "complex group sample",
        "cfg_id": 1
      }
    ],
    "18": {
      "7": "default group sample"
    }
  }
}
GET /api/v2/assets/not-found-id/custom_fields
404
{
  "error": "asset not found"
}

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

POST /api/v2/assets/:asset_id/custom_fields/:field_group_id
Update field group for asset, Including fields

Field types and validations

date

String in format YYYY-MM-DD. Eg. 2020-01-30

textbox

String

textarea

String

rich_text

Simple HTML formatting. Allowed tags: p strong em ins ul ol li h1 h2 h3 h4 h5 h6. Everything else is parsed out.

dropdown

String

boolean

Boolean, true/false

datetime

String in format yyyy-mm-ddThh:mm:ss.mmm. Eg. 2021-08-01T00:00:00.000Z

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

POST /api/v2/assets/_o2vT3wBW4fR4Me2gHy4/custom_fields/19
{
  "custom_fields": {
    "8": "test"
  }
}
200
{
  "custom_fields": {
    "19": {
      "8": "test"
    }
  },
  "errors": []
}
POST /api/v2/assets/_42vT3wBW4fR4Me2iXwa/custom_fields/20
{
  "custom_fields": [
    {
      "9": "test"
    },
    {
      "10": "test2"
    }
  ]
}
200
{
  "custom_fields": {
    "20": [
      {
        "9": "test",
        "cfg_id": 2
      },
      {
        "cfg_id": 3,
        "10": "test2"
      }
    ]
  },
  "errors": []
}
POST /api/v2/assets/AI2vT3wBW4fR4Me2lX1n/custom_fields/21
{
  "custom_fields": [
    {
      "cfg_id": 5,
      "11": "test_value5",
      "12": "test_value6"
    }
  ]
}
200
{
  "custom_fields": {
    "21": [
      {
        "11": "test_value1",
        "12": "test_value2",
        "cfg_id": 4
      },
      {
        "11": "test_value5",
        "12": "test_value6",
        "cfg_id": 5
      }
    ]
  },
  "errors": []
}
POST /api/v2/assets/AY2vT3wBW4fR4Me2sn0z/custom_fields/22
{
  "custom_fields": {
    "not-found": "test"
  }
}
200
{
  "custom_fields": null,
  "errors": [
    {
      "not-found": "Field not found"
    }
  ]
}
POST /api/v2/assets/not-found-id/custom_fields/23
{
  "custom_fields": {
    "14": "test"
  }
}
404
{
  "error": "asset not found"
}
POST /api/v2/assets/A42vT3wBW4fR4Me2un33/custom_fields/not-found
{
  "custom_fields": {
    "15": "test"
  }
}
404
{
  "error": "Field group not found"
}

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String

custom_fields
optional

Custom fields

Validations:

  • Must be an array of any type

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

DELETE /api/v2/assets/:asset_id/custom_fields/:field_group_id
Remove field group from asset

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

DELETE /api/v2/assets/BY2vT3wBW4fR4Me2z30z/custom_fields/26
200
{
  "custom_fields": {},
  "errors": []
}
DELETE /api/v2/assets/Bo2vT3wBW4fR4Me22n1t/custom_fields/not-found-id
404
{
  "error": "Field group not found"
}
DELETE /api/v2/assets/not-found-id/custom_fields/27
404
{
  "error": "asset not found"
}

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

DELETE /api/v2/assets/:asset_id/custom_fields/:field_group_id/:complex_field_group_id
Delete complex field group from asset

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

DELETE /api/v2/assets/BI2vT3wBW4fR4Me2vn3u/custom_fields/25/6
200
{
  "message": "Complex field group 6 removed successfully."
}

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

GET /api/v2/projects/:project_id/custom_fields
Returns custom fields for project

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

GET /api/v2/projects/CI2vT3wBW4fR4Me24n1O/custom_fields
200
{
  "id": "CI2vT3wBW4fR4Me24n1O",
  "custom_fields": {
    "28": [
      {
        "19": "complex group sample",
        "cfg_id": 7
      }
    ],
    "29": {
      "20": "default group sample"
    }
  }
}
GET /api/v2/projects/not-found-id/custom_fields
404
{
  "error": "project not found"
}

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

POST /api/v2/projects/:project_id/custom_fields/:field_group_id
Update field group for project, Including fields

Field types and validations

date

String in format YYYY-MM-DD. Eg. 2020-01-30

textbox

String

textarea

String

rich_text

Simple HTML formatting. Allowed tags: p strong em ins ul ol li h1 h2 h3 h4 h5 h6. Everything else is parsed out.

dropdown

String

boolean

Boolean, true/false

datetime

String in format yyyy-mm-ddThh:mm:ss.mmm. Eg. 2021-08-01T00:00:00.000Z

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

POST /api/v2/projects/Co2vT3wBW4fR4Me28n3h/custom_fields/30
{
  "custom_fields": {
    "21": "test"
  }
}
200
{
  "custom_fields": {
    "30": {
      "21": "test"
    }
  },
  "errors": []
}
POST /api/v2/projects/C42vT3wBW4fR4Me2-n3Y/custom_fields/31
{
  "custom_fields": [
    {
      "cfg_id": 9,
      "22": "test_value5",
      "23": "test_value6"
    }
  ]
}
200
{
  "custom_fields": {
    "31": [
      {
        "22": "test_value1",
        "23": "test_value2",
        "cfg_id": 8
      },
      {
        "22": "test_value5",
        "23": "test_value6",
        "cfg_id": 9
      }
    ]
  },
  "errors": []
}
POST /api/v2/projects/DI2wT3wBW4fR4Me2GX2t/custom_fields/32
{
  "custom_fields": {
    "not-found": "test"
  }
}
200
{
  "custom_fields": null,
  "errors": [
    {
      "not-found": "Field not found"
    }
  ]
}
POST /api/v2/projects/not-found-id/custom_fields/33
{
  "custom_fields": {
    "25": "test"
  }
}
404
{
  "error": "project not found"
}
POST /api/v2/projects/Do2wT3wBW4fR4Me2IX3h/custom_fields/not-found
{
  "custom_fields": {
    "26": "test"
  }
}
404
{
  "error": "Field group not found"
}

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String

custom_fields
optional

Custom fields

Validations:

  • Must be an array of any type

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

DELETE /api/v2/projects/:project_id/custom_fields/:field_group_id
Remove field group from project

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Examples

DELETE /api/v2/projects/D42wT3wBW4fR4Me2Jn1M/custom_fields/35
200
{
  "custom_fields": {},
  "errors": []
}
DELETE /api/v2/projects/EI2wT3wBW4fR4Me2L31U/custom_fields/not-found-id
404
{
  "error": "Field group not found"
}
DELETE /api/v2/projects/not-found-id/custom_fields/36
404
{
  "error": "project not found"
}

Params

Param name Description
field_group_id
required

Field group ID

Validations:

  • Must be a String

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY

DELETE /api/v2/projects/:project_id/custom_fields/:field_group_id/:complex_field_group_id
Delete complex field group from project

Errors

Code Description
401 Unauthorized
500 Internal Server Error
422 Missing parameters

Headers

Header name Description
Content-Type
required
application/json
X-API-KEY
required
YOUR_API_KEY