|
ExtraObjectValue
An object that represents a BlueCamroo ExtraObjectValue.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID for the ExtraObjectValue. When adding a new ExtraObjectValue object the value must be 0. |
|
ExtraId |
integer |
The ID of the parent ExtraObject. |
|
ParentId |
integer |
The ID of the object the extra data object is attached to. |
|
ParentObject |
string (100) |
Indicates the parent object type (e.g., account, person, project, etc.). |
|
RowData |
List<ObjectData> |
A list of data for the row. |
|
FieldList |
List<ExtraObjectField> |
A list of data for the field. |
List
Description
Returns a list of all extra object values.
URL
https://{company}.bluecamroo.com/api/ExtraObjectValue/list
HTTP Method
GET
Data Return
Returns the list of ExtraObjectValues in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Get
Description
Returns the details of a single extra object value.
URL
https://{company}.bluecamroo.com/api/ExtraObjectValue/get/{id}?extraId={extraId}
HTTP Method
GET
Parameters
None
Data Return
Returns an ExtraObjectValue in use for the ID of the parent object and the type of ExtraObjectValue as identified by extraID (the ID of the extra object type) in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds the extra object value.
URL
https://{company}.bluecamroo.com/api/ExtraObjectValue/add
HTTP Method
POST
Parameters
An ExtraObjectValue object
Data Return
Returns the ExtraObjectValue in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Updates an extra object value.
URL
https://{company}.bluecamroo.com/api/ExtraObjectValue/update
HTTP Method
PUT
Parameters
An ExtraObjectValue object.
Data Return
Returns the ExtraObjectValue object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the specified Extra Object value based on the id (of the parent object) and extraID (id of the ExtraObjectValue type).
URL
https://{company}.bluecamroo.com/api/ExtraObjectValue/delete/{id}?extraid={extraid}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|