Page Comparison

The WorkBook API is a standard REST API that can send and receive requests in JSON or JSV (JSON + CSV) formats. Read about REST API.

You can see the Postman documentation here:

To see ALL the available endpoints, open a browser and type in [your WorkBook URL]/api/custommetadata, it includes a search area and a standard verb filter. An example of this would be https://tangramdemo.workbook.net/api/custommetadata and you would replace tangram with your own system name or simply use ours as a reference point.in:

https://{base url}.workbook.net/api/metadata

...

Extensibility

Along with using custom fields, WorkBook allows the use of Databoards and Custom Codes.

Databoards can be especially useful, as they allow for direct Read-Only SQL code to be executed, meaning that you can create custom reports and tables and then query the data with one API call.

Combined with parameters to query the SQL with WHERE clauses, this can dramatically reduce and limit the amount of API calls and application logic.

You can read more about this in the Postman documentation.

...

JAVASCRIPT & API

If the API is called using javascriptJavaScript, you must set the system variable setting 1061, CORSWebSites to the correct sender address. Otherwise, the server blocks the request.

...

• Navigate to settings module > global system settings > system variables.

• In the find setting number field > type 1061

...

SOME NOTEWORTHY EXAMPLE ENDPOINTS

...

[TasksRequest] 

...

[TaskRequest] /api/task/{Id} 

...

[JobsRequest] /api/jobs 

...

[JobRequest] /api/job/{Id} 

...

[ResourceRequest] api/resource/{Id} 

...

• Timesheets

Button macro

buttonText Postman isButtonShadowOn true emoji {} buttonColor #ff8224ff buttonBorderColor #ff8224ff buttonBorderHoverColor #ff8224ff buttonNewTab true buttonFontColor #ffffffff buttonSize small buttonIconColor #ffffffff buttonWidthDetection auto buttonHoverColor #f47d28ff buttonFontHoverColor #ffffffff buttonIconHoverColor #ffffffff buttonIcon material-design/Code buttonType icon_left buttonLink {"link":"https://workbookapi.deltek.com/#adedd734-7010-4eec-b624-d43993867f83","source":"direct"} buttonRadius 20 buttonNewLink emojiEnabled false buttonWidth 20

• Finance

Button macro

buttonText Postman isButtonShadowOn true emoji {} buttonColor #ff8224ff buttonBorderColor #ff8224ff buttonBorderHoverColor #ff8224ff buttonNewTab true buttonFontColor #ffffffff buttonSize small buttonIconColor #ffffffff buttonWidthDetection auto buttonHoverColor #f47d28ff buttonFontHoverColor #ffffffff buttonIconHoverColor #ffffffff buttonIcon material-design/Code buttonType icon_left buttonLink {"link":"https://workbookapi.deltek.com/#9486ebc5-6a96-4695-a53f-489086dcc3d9","source":"direct"} buttonRadius 20 buttonNewLink emojiEnabled false buttonWidth 20

• Resources

Button macro

buttonText Postman isButtonShadowOn true emoji {} buttonColor #ff8224ff buttonBorderColor #ff8224ff buttonBorderHoverColor #ff8224ff buttonNewTab true buttonFontColor #ffffffff buttonSize small buttonIconColor #ffffffff buttonWidthDetection auto buttonHoverColor #f47d28ff buttonFontHoverColor #ffffffff buttonIconHoverColor #ffffffff buttonIcon material-design/Code buttonType icon_left buttonLink {"link":"https://workbookapi.deltek.com/#d059bbf2-56fc-4c0b-83cf-154631a5597b","source":"direct"} buttonRadius 20 buttonNewLink emojiEnabled false buttonWidth 20

• Documents

Button macro

buttonText Postman isButtonShadowOn true emoji {} buttonColor #ff8224ff buttonBorderColor #ff8224ff buttonBorderHoverColor #ff8224ff buttonNewTab true buttonFontColor #ffffffff buttonSize small buttonIconColor #ffffffff buttonWidthDetection auto buttonHoverColor #f47d28ff buttonFontHoverColor #ffffffff buttonIconHoverColor #ffffffff buttonIcon material-design/Code buttonType icon_left buttonLink {"link":"https://workbookapi.deltek.com/#97754d70-fae6-47c4-a06e-bb253aafc4ba","source":"direct"} buttonRadius 20 buttonNewLink emojiEnabled false buttonWidth 20

• Employees

Button macro

buttonText Postman isButtonShadowOn true emoji {} buttonColor #ff8224ff buttonBorderColor #ff8224ff buttonBorderHoverColor #ff8224ff buttonNewTab true buttonFontColor #ffffffff buttonSize small buttonIconColor #ffffffff buttonWidthDetection auto buttonHoverColor #f47d28ff buttonFontHoverColor #ffffffff buttonIconHoverColor #ffffffff buttonIcon material-design/Code buttonType icon_left buttonLink {"link":"https://workbookapi.deltek.com/#946c43a7-1d3c-42c2-9efe-b07d64864216","source":"direct"} buttonRadius 20 buttonNewLink emojiEnabled false buttonWidth 20

• Jobs

Button macro

buttonText Postman isButtonShadowOn true emoji {} buttonColor #ff8224ff buttonBorderColor #ff8224ff buttonBorderHoverColor #ff8224ff buttonNewTab true buttonFontColor #ffffffff buttonSize small buttonIconColor #ffffffff buttonWidthDetection auto buttonHoverColor #f47d28ff buttonFontHoverColor #ffffffff buttonIconHoverColor #ffffffff buttonIcon material-design/Code buttonType icon_left buttonLink {"link":"https://workbookapi.deltek.com/#16073aec-c43d-43a6-92bf-46a8d214873e","source":"direct"} buttonRadius 20 buttonNewLink emojiEnabled false buttonWidth 20

...

ADDITIONAL API INFORMATION

For additional API information refer to the articles below.

...