{ "opencollection": "1.0.0", "info": { "name": "Openpath API Documentation auth orgs/customFields API", "version": "1.0.0" }, "items": [ { "info": { "name": "orgs/customFields", "type": "folder" }, "items": [ { "info": { "name": "List all custom fields", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/customFields", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "preFilter", "value": "", "type": "query" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-rpt:r,o{params.orgId}-rpt:w,o{params.orgId}-musterReport:r,o{params.orgId}-musterReport:w,o{params.orgId}-occupancyReport:r,o{params.orgId}-occupancyReport:w,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listCustomFields" }, { "info": { "name": "Create a custom field", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/orgs/:orgId/customFields", "params": [ { "name": "orgId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w

__Endpoint name__: createCustomField" }, { "info": { "name": "Bulk update custom fields", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/orgs/:orgId/customFields", "params": [ { "name": "orgId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w

__Endpoint name__: updateCustomFields" }, { "info": { "name": "Describe a custom field", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/customFields/:customFieldId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "customFieldId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: describeCustomField" }, { "info": { "name": "Update a custom field", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/orgs/:orgId/customFields/:customFieldId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "customFieldId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w

__Endpoint name__: updateCustomField" }, { "info": { "name": "Delete a custom field", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/orgs/:orgId/customFields/:customFieldId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "customFieldId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w

__Endpoint name__: deleteCustomField" }, { "info": { "name": "List all custom field dropdown items", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/customFields/:customFieldId/dropdownItems", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "customFieldId", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "offset", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "order", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "preFilter", "value": "", "type": "query" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: listCustomFieldDropdownItems" }, { "info": { "name": "Create a custom field dropdown item", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/orgs/:orgId/customFields/:customFieldId/dropdownItems", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "customFieldId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w

__Endpoint name__: createCustomFieldDropdownItem" }, { "info": { "name": "Bulk update custom field dropdown items", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/orgs/:orgId/customFields/:customFieldId/dropdownItems", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "customFieldId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w

__Endpoint name__: updateCustomFieldDropdownItems" }, { "info": { "name": "Describe a custom field dropdown item", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/orgs/:orgId/customFields/:customFieldId/dropdownItems/:dropdownItemId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "customFieldId", "value": "", "type": "path" }, { "name": "dropdownItemId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o{params.orgId}-user:r,o:w,o:r,s-o:w,s-o:r

__Endpoint name__: describeCustomFieldDropdownItem" }, { "info": { "name": "Update a custom field dropdown item", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/orgs/:orgId/customFields/:customFieldId/dropdownItems/:dropdownItemId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "customFieldId", "value": "", "type": "path" }, { "name": "dropdownItemId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w

__Endpoint name__: updateCustomFieldDropdownItem" }, { "info": { "name": "Delete a custom field dropdown item", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/orgs/:orgId/customFields/:customFieldId/dropdownItems/:dropdownItemId", "params": [ { "name": "orgId", "value": "", "type": "path" }, { "name": "customFieldId", "value": "", "type": "path" }, { "name": "dropdownItemId", "value": "", "type": "path" } ] }, "docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-user:w,o:w,s-o:w

__Endpoint name__: deleteCustomFieldDropdownItem" } ] } ], "bundled": true }