{
"opencollection": "1.0.0",
"info": {
"name": "Bench AccountActivities PersonFields API",
"version": "1.0"
},
"items": [
{
"info": {
"name": "PersonFields",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all the person field definitions on the given account.",
"type": "http"
},
"http": {
"method": "GET",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/person-fields",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The account ID"
}
]
},
"docs": "
Permissions
Account: Read
Private: Read
Finance: Read
Person: Read
HourlyProfile: Read"
},
{
"info": {
"name": "Adds or updates person field definitions on the given account.",
"type": "http"
},
"http": {
"method": "POST",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/person-fields",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "If you pass in a FieldDefRequest object without an \"id\" this endpoint will add a new one to the account if the name isn't reserved or in use.\n\nIf you pass in a FieldDefRequest object with an \"id\" this endpoint will update an existing one that matches the id.\n\nTo add a value or multiple values to a selection list you must pass an array of \"definedValues\" that contain objects with a \"definedValue\" property of the value you want to add.\n\nTo update a value or multiple values in a selection list you "
},
{
"info": {
"name": "Deletes one or more person field definitions in the given account by ids",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/person-fields",
"params": [
{
"name": "id",
"value": "",
"type": "path"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "NOTE: system fields cannot be deleted.
Permissions
Account: Write"
},
{
"info": {
"name": "Update the display order of person field definitions for the given account.",
"type": "http"
},
"http": {
"method": "PUT",
"url": "https://bench.gobridgit.com/rp/api/v1/accounts/:id/person-fields/_reorder",
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "The account ID"
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Accepts an array of objects containing fieldId and displayOrder.\n\nSystem fields cannot be reordered and should not be included in the request.\n\nAll custom fields should be included with their new display order values.
Permissions
Account: Write"
}
]
}
],
"bundled": true
}