REST API: Custom Fields

Methods

getCustomFields
getCustomField
createCustomField
updateCustomField
deleteCustomFields

TypeVer.Command parameterParameters
Getters
GET3.0sp5+ getCustomFields nodeType=<nodeType>
Example of success:
{
  "list": {
    "object": [
      {
        "possibleValues": "-",
        "typeCustomField": "boolean",
        "defaultValue": 1,
        "name": "Validated (custom field)",
        "id": 15,
        "position": 6,
        "type": "boolean",
        "mandatory": 1
      },
      {
        "possibleValues": "-",
        "typeCustomField": "html",
        "defaultValue": "",
        "name": "Comments (custom field)",
        "id": 31,
        "position": 7,
        "type": "formatted string (wiki)",
        "mandatory": 0
      }
    ]
  }
}
GET3.0sp7+ getCustomField nodeType=<nodeType>
customFieldId=<id>
type=<customFieldType>
Example of success:
{
  "form": {
    "formItem": [
      {
        "name": "id",
        "id": 0,
        "type": "integer",
        "value": 3
      },
      {
        "name": "name",
        "id": 1,
        "type": "string",
        "value": "New custom field string 2"
      },
      {
        "name": "type",
        "id": 2,
        "type": "string",
        "value": "string"
      },
      {
        "name": "position",
        "id": 6,
        "type": "integer",
        "value": 54
      },
      {
        "name": "mandatory",
        "id": 5,
        "type": "integer",
        "value": 0
      },
      {
        "name": "defaultValue",
        "id": 4,
        "type": "integer",
        "value": "new custom field string content"
      },
      {
        "name": "possibleValues",
        "id": 3,
        "type": "string",
        "value": "-"
      }
    ]
  }
}
POST3.2b0 createCustomField nodeType=<nodeType>
List of all properties must be passed in the
request's body as multi-part.
Example of body:
{
  "defaultValue": "bbb",
  "mandatory": true,
  "name": "New custom field choice",
  "position": 2,
  "possibleValues": "aaa;bbb;ccc",
  "typeCustomField": "choice"
}

Example of success:
{
  "result": "success",
  "id": 123
}

Example of failure:
{
  "result": "failure",
  "message": ""
}
POST3.0sp7+ updateCustomField nodeType=<nodeType>
type=<customFieldType>
List of all properties must be passed in the
request's body as multi-part.
Example of body:
{
  "defaultValue": "bbb",
  "mandatory": true,
  "name": "New custom field choice",
  "position": 2,
  "possibleValues": "aaa;bbb;ccc",
  "typeCustomField": "choice"
}

Example of success:
{
  "result": "success",
  "id": 123
}

Example of failure:
{
  "result": "failure",
  "message": ""
}
POST3.0sp7+ deleteCustomFields treeType=<treeType>
customFieldTypes=<customFieldType, customFieldType, ...>
customFieldIds=<id, id, ...>
Example of success:
{
  "result": "success",
  "message": "result: 1"
}
Loading...