Use the Hub APIs to perform
Create,
Read,
Update, and
Delete (CRUD) operations on hub data.
APIs are available for accessing each of the categories of hub data shown in the first column of the following table. The example HTTP requests are illustrative of the available endpoints for each category. For a listing of available API endpoints, see the
interactive visualization. Execute a GET on the appropriate endpoint to find out what metadata is available to you. The APIs you use to get the metadata for each hub all have the form
{{url}}/metadata/<hub_name>/. For example, to get the metadata for the
Contacts hub, execute a GET on
https://{{url}}/metadata/contact/.
| API
|
Example HTTP Request
|
Description
|
| Activity
|
GET api/activity
|
Get all activities.
|
| POST api/activity
|
Create an activity.
|
| GET api/activity/{ID}
|
Read the specified activity.
|
| PUT api/activity/{ID}
|
Update the specified activity.
|
| DELETE api/activity/{ID}
|
Delete the specified activity.
|
| API
|
Example HTTP Request
|
Description
|
| Boilerplate
|
GET api/boilerplate/
|
Get all boilerplates.
|
| POST api/boilerplate/
|
Create a boilerplate.
|
| GET api/boilerplate/{Name}
|
Read the specified boilerplate.
|
| PUT api/boilerplate/{Name}
|
Update the specified boilerplate.
|
| DELETE PUT api/boilerplate/{Name}
|
Delete the specified boilerplate.
|
| API
|
Example HTTP Request
|
Description
|
| Marketing Campaign
|
GET api/campaign
|
Get all
marketing campaigns.
|
| POST api/campaign
|
Create a
marketing campaign.
|
| GET api/campaign/{CampaignID}
|
Read the specified
marketing campaign.
|
| PUT api/campaign/{CampaignID}
|
Update the specified
marketing campaign.
|
| DELETE api/campaign/{CampaignID}
|
Delete the specified
marketing campaign.
|
| API
|
Example HTTP Request
|
Description
|
| Contact
|
GET api/contact
|
Get all
contacts.
|
| POST api/contact
|
Create a
contact.
|
| GET api/contact/{ID}
|
Read the specified
contact.
|
| PUT api/contact/{ID}
|
Update the specified
contact.
|
| DELETE api/contact/{ID}
|
Delete the specified
contact.
|
| API
|
Example HTTP Request
|
Description
|
| Employee
|
GET api/employee
|
Get all
employees.
|
| POST api/employee
|
Create an
employee. After you create an
employee record, you can use other APIs to bring in skills, credentials, education information, and citizenship information for the
employee.
|
| GET api/employee/{employeekey}
|
Read the specified
employee.
|
| PUT api/employee/{employeekey}
|
Update the specified
employee.
|
| DELETE api/employee/{employeekey}
|
Delete the specified
employee.
|
| API
|
Example HTTP Request
|
Description
|
| Firm
|
GET api/firm
|
Get all
firms.
|
| POST api/firm
|
Create a
firm.
|
| GET api/firm/{ClientID}
|
Read the specified
firm.
|
| PUT api/firm/{ClientID}
|
Update the specified
firm.
|
| DELETE api/firm/{ID}
|
Delete the specified
firm.
|
| API
|
Example HTTP Request
|
Description
|
|
Project
|
Enable the Accounting module to use /project endpoints.
|
| GET api/project
|
Get all
projects.
|
| POST api/project
|
Create a
project. Within the work breakdown structure number WBS for a given
project, you must import a higher-level WBS element before you can import the related lower-level WBS elements below it in the WBS hierarchy. Each lower-level element record that you create with this API must include the ID of its parent element at the next higher level of the WBS.
|
| GET api/project/{wbskey}
|
Read the specified
project.
|
| PUT api/project/{wbskey}
|
Update the specified
project.
|
| DELETE api/project/{wbskey}
|
Delete the specified
project.
|
