Skip to main content

 

Planview Customer Success Center

Fieldset Service

GET /fieldsets/{fieldsetBn}

Description:

Read a fieldset.

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/plain;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/fieldsets/040I000000KM
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8

Response:

{
  "bn": "040I000000KM",
  "expanded": false,
  "fields": [
    {
      "bn": "040L00000250",
      "choices": [
        {
          "bn": "040P000074PD",
          "displayValue": "Leveraged",
          "storedValue": "Leveraged"
        },
        {
          "bn": "040P000074PF",
          "displayValue": "Exception Required",
          "storedValue": "Exception Required"
        },
        {
          "bn": "040P000074PG",
          "displayValue": "Not Applicable",
          "storedValue": "NA"
        }
      ],
      "dataType": "TEXT",
      "decimalPlaces": 2,
      "displayType": "SINGLE_SELECT",
      "fieldId": "AgentAssignmentService_Asset",
      "fieldLength": 1000,
      "helpText": "",
      "controlLevel": "EDITABLE",
      "name": "Agent Assignment Service(AAS) (Asset)",
      "notes": "",
      "sortVal": 0
    }
  ],
  "helpText": "The help",
  "name": "bIT Fieldset EDITED",
  "notes": "bIT Notes"
}

 

 

POST /fieldsets/{fieldsetBn}

Description:

Create a fieldset.

Parameters (body)

  • expanded: (Boolean) This sets the initial display state for a Fieldset.
  • fields: (JSON Object) This is an array of field BNs that you'd like to add Fieldset.
  • fieldsetId: (String) A unique Fieldset identifier.
  • name: (String) The display name of the Fieldset.

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/plain;charset=UTF-8
  • Content-Type: application/plain;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/fieldsets
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8

{
  "expanded": true,
  "fields": [
      "040L0000009V",
      "040L000001KH"
    ],
  "fieldsetId": "fieldset Alpha",
  "name": "bIT API Fieldset"
}

Response:

{
  "bn": "040I000000KM",
  "expanded": true,
  "fields": [
    "040L0000009V",
    "040L000001KH"
  ],
  "name": "bIT API Fieldset"
}

 

 

PUT /fieldsets/{fieldsetBn}

Description:

Update a fieldset.

Parameters (body)

  • bn: (String) The Barometer Number for the Fieldset.
  • expanded: (Boolean) This sets the initial display state for a Fieldset.
  • fields: (JSON Object) This is an array of field BNs that you'd like to add Fieldset.
  • fieldsetId: (String) A unique Fieldset identifier.
  • name: (String) The display name of the Fieldset.

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/plain;charset=UTF-8
  • Content-Type: application/plain;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/fieldsets/040I000000KM
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8
Content-Type: application/json;charset=UTF-8

{
  "bn": "040I000000KM",
  "expanded": false,
  "helpText": "The help",
  "name": "bIT Fieldset EDITED",
  "notes": "bIT Notes",
  "fields": [
  	{"bn": "040L00000250", "sortVal": 0}
  ]
}

Response:

{
  "bn": "040I000000KM",
  "expanded": false,
  "fields": [
    {
      "bn": "040L00000250",
      "name": "Agent Assignment Service(AAS) (Asset)",
      "sortVal": "0"
    }
  ],
  "helpText": "The help",
  "name": "bIT Fieldset EDITED",
  "notes": "bIT Notes"
}

 

 

DELETE /fieldsets/{fieldsetBn}

Description:

Delete a fieldset.

 

Headers:

  • Authorization: (Your Basic Auth String)

Example:

Request:

https://[tenant-end-point]/api/c/fieldsets/040I000000KN
Authorization: Basic {your basic auth}

Response:

{
  "successfulEntities": [
    {
      "bn": "040I000000KN",
      "description": "The help",
      "expanded": false,
      "lastUpdateDate": "2017-05-15T19:54:59.226+0000",
      "name": "bIT Fieldset EDITED",
      "notes": "bIT Notes",
      "updatedByBn": {
        "bn": "040E000007NN",
        "firstName": "David",
        "lastName": "Lewis-Frazier",
        "deleted": false
      },
      "displayableName": "bIT Fieldset EDITED",
      "new": false,
      "class": "bit.service.udf.fieldset.FieldSetImpl"
    }
  ]
}

 

 

DELETE /fieldsets/{fieldsetBn}/fields/{fieldBn}

Description:

Remove a field from a fieldset.

 

Headers:

  • Authorization: (Your Basic Auth String)
  • Accept: application/plain;charset=UTF-8

Example:

Request:

https://[tenant-end-point]/api/c/fieldsets/040I000000KN/fields/040L000001KH
Authorization: Basic {your basic auth}
Accept: application/json;charset=UTF-8

Response:

{
  "message": "OK: 040L000001KH was removed from 040I000000KN."
}