Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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:

Button macro
buttonTextPostman
isButtonShadowOntrue
emoji{}
buttonColor#ff8224ff
buttonBorderColor#ff8224ff
buttonBorderHoverColor#ff8224ff
buttonNewTabtrue
buttonFontColor#ffffffff
buttonSizesmall
buttonIconColor#ffffffff
buttonWidthDetectionauto
buttonHoverColor#f47d28ff
buttonFontHoverColor#ffffffff
buttonIconHoverColor#ffffffff
buttonIconmaterial-design/Code
buttonTypeicon_left
buttonRadius20
buttonLink{"link":"https://workbookapi.deltek.com/","source":"direct"}
buttonNewLink
emojiEnabledfalse
buttonWidth20

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 in:

https://tangramdemo{base url}.workbook.net/api/custommetadata replacing ‘tangramdemo’ with your own system name or simply using ours as a reference point.metadata

...

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
buttonTextPostman
isButtonShadowOntrue
emoji{}
buttonColor#ff8224ff
buttonBorderColor#ff8224ff
buttonBorderHoverColor#ff8224ff
buttonNewTabtrue
buttonFontColor#ffffffff
buttonSizesmall
buttonIconColor#ffffffff
buttonWidthDetectionauto
buttonHoverColor#f47d28ff
buttonFontHoverColor#ffffffff
buttonIconHoverColor#ffffffff
buttonIconmaterial-design/Code
buttonTypeicon_left
buttonRadius20
buttonLink{"link":"https://workbookapi.deltek.com/#adedd734-7010-4eec-b624-d43993867f83","source":"direct"}
buttonNewLink
emojiEnabledfalse
buttonWidth20

  • Finance

Button macro
buttonTextPostman
isButtonShadowOntrue
emoji{}
buttonColor#ff8224ff
buttonBorderColor#ff8224ff
buttonBorderHoverColor#ff8224ff
buttonNewTabtrue
buttonFontColor#ffffffff
buttonSizesmall
buttonIconColor#ffffffff
buttonWidthDetectionauto
buttonHoverColor#f47d28ff
buttonFontHoverColor#ffffffff
buttonIconHoverColor#ffffffff
buttonIconmaterial-design/Code
buttonTypeicon_left
buttonRadius20
buttonLink{"link":"https://workbookapi.deltek.com/#9486ebc5-6a96-4695-a53f-489086dcc3d9","source":"direct"}
buttonNewLink
emojiEnabledfalse
buttonWidth20

  • Resources

Button macro
buttonTextPostman
isButtonShadowOntrue
emoji{}
buttonColor#ff8224ff
buttonBorderColor#ff8224ff
buttonBorderHoverColor#ff8224ff
buttonNewTabtrue
buttonFontColor#ffffffff
buttonSizesmall
buttonIconColor#ffffffff
buttonWidthDetectionauto
buttonHoverColor#f47d28ff
buttonFontHoverColor#ffffffff
buttonIconHoverColor#ffffffff
buttonIconmaterial-design/Code
buttonTypeicon_left
buttonRadius20
buttonLink{"link":"https://workbookapi.deltek.com/#d059bbf2-56fc-4c0b-83cf-154631a5597b","source":"direct"}
buttonNewLink
emojiEnabledfalse
buttonWidth20

  • Documents

Button macro
buttonTextPostman
isButtonShadowOntrue
emoji{}
buttonColor#ff8224ff
buttonBorderColor#ff8224ff
buttonBorderHoverColor#ff8224ff
buttonNewTabtrue
buttonFontColor#ffffffff
buttonSizesmall
buttonIconColor#ffffffff
buttonWidthDetectionauto
buttonHoverColor#f47d28ff
buttonFontHoverColor#ffffffff
buttonIconHoverColor#ffffffff
buttonIconmaterial-design/Code
buttonTypeicon_left
buttonRadius20
buttonLink{"link":"https://workbookapi.deltek.com/#97754d70-fae6-47c4-a06e-bb253aafc4ba","source":"direct"}
buttonNewLink
emojiEnabledfalse
buttonWidth20

  • Employees

Button macro
buttonTextPostman
isButtonShadowOntrue
emoji{}
buttonColor#ff8224ff
buttonBorderColor#ff8224ff
buttonBorderHoverColor#ff8224ff
buttonNewTabtrue
buttonFontColor#ffffffff
buttonSizesmall
buttonIconColor#ffffffff
buttonWidthDetectionauto
buttonHoverColor#f47d28ff
buttonFontHoverColor#ffffffff
buttonIconHoverColor#ffffffff
buttonIconmaterial-design/Code
buttonTypeicon_left
buttonRadius20
buttonLink{"link":"https://workbookapi.deltek.com/#946c43a7-1d3c-42c2-9efe-b07d64864216","source":"direct"}
buttonNewLink
emojiEnabledfalse
buttonWidth20

  • Jobs

Button macro
buttonTextPostman
isButtonShadowOntrue
emoji{}
buttonColor#ff8224ff
buttonBorderColor#ff8224ff
buttonBorderHoverColor#ff8224ff
buttonNewTabtrue
buttonFontColor#ffffffff
buttonSizesmall
buttonIconColor#ffffffff
buttonWidthDetectionauto
buttonHoverColor#f47d28ff
buttonFontHoverColor#ffffffff
buttonIconHoverColor#ffffffff
buttonIconmaterial-design/Code
buttonTypeicon_left
buttonRadius20
buttonLink{"link":"https://workbookapi.deltek.com/#16073aec-c43d-43a6-92bf-46a8d214873e","source":"direct"}
buttonNewLink
emojiEnabledfalse
buttonWidth20

...

ADDITIONAL API INFORMATION

...