Company

What can you do with Company?


Properties

Property Details
id
"id": 973
Type: Number
This is the unique numeric identifier for the Company
ownerId
"ownerId": 973
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • identity
  • name

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Company object.

Standard PATCH objects:

  • address - create, update, delete, attach, detach

DataFlow PATCH objects:

  • company - create, update, delete
  • address - create, update, delete, attach, detach

End Points

DELETEapi/v1/Company/{id:int}
Delete an instance of the Company object.
GETapi/v1/Company
Retrieve all of the Company objects.
GETapi/v1/Company/Metadata
Retrieve all of the meta data details of the Company object.
GETapi/v1/Company/Metadata/{option}
Retrieve all the meta data details of the Company object based on provided options.
{option}Metadata options for the Company object.
GETapi/v1/Company/Paged
Retreive all of the Company objects in a paged fashion.
GETapi/v1/Company/Paged/Detail
Retreive all of the Company objects in a paged fashion with all object details.
GETapi/v1/Company/{id:int}
Retrieve an instance of the Company object by it's ID.
{id:int}Unique identifier for the Company object.
GETapi/v1/Company/{id:int}/Detail
Retreive all of the Detail objects for the specified Company.
{id:int}Unique identifier for the Company object.
PATCHapi/v1/Company/{id:int}
Update the Company object and optionally make changes to any child objects.
POSTapi/v1/Company
Create a new instance of the Company object.
PUTapi/v1/Company/{id:int}
Update an existing instance of the Company object.