|
ExtraObject
An object that represents a BlueCamroo ExtraObject. You first create the "template" for the object. Objects can then be created as child objects of particular record-type objects like an organization or a project.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID representing the ExtraObject object. When adding a new ExtraObject the value must be 0. |
|
Name |
string (100) |
Enter the object's database name. Use only alphanumeric characters. Do not use spaces. E.g., InventorySheet. |
|
Label |
string (100) |
The object's name as it appears to users. |
|
ParentObject |
string (100) |
Name of the parent object that can create this object. Values are: Lead, Account (if it's an organization), Contact, Opportunity, Project, Case. |
|
IsTableCreated |
boolean |
Flag to indicate if the extra object has a created instance. |
List
Description
Returns a list of all extra objects.
URL
https://{company}.bluecamroo.com/api/extraobject/list
HTTP Method
GET
Data Return
Returns the list of extraobjects 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)
List</h1>
Description
Lists the actual objects in use by a particular record.
URL
http://{company}.bluecamroo.com/api/extraobject/list?extraId={extraId}&parentId={parentId}&parentObject={parentObject}
HTTP Method
GET
Parameters
None
Data Return
Returns the list of extra objects in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Get
Description
Returns the details of a single extra object.
URL
https://{company}.bluecamroo.com/api/extraobject/get/{id}?extraId={extraId}
HTTP Method
GET
Parameters
None
Data Return
Returns an extraobject in use for the ID of the parent object and the type of extraobject 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.
URL
https://{company}.bluecamroo.com/api/extraobject/add
HTTP Method
POST
Parameters
An extraobject object
Data Return
Returns the extraobject 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.
URL
https://{company}.bluecamroo.com/api/extraobject/update
HTTP Method
PUT
Parameters
An extraobject object.
Data Return
Returns the extraobject 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 based on the id (of the parent object) and extraID (id of the extraobject type).
URL
https://{company}.bluecamroo.com/api/extraobject/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)
|