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 |
---|
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 |
---|
buttonRadius | 20 |
---|
buttonLink | {"link":"https://workbookapi.deltek.com/","source":"direct"} |
---|
buttonNewLink | |
---|
emojiEnabled | false |
---|
buttonWidth | 20 |
---|
|
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.
...
...
SOME NOTEWORTHY EXAMPLE ENDPOINTS
...
[TasksRequest]
...
[TaskRequest] /api/task/{Id}
...
[JobsRequest] /api/jobs
...
[JobRequest] /api/job/{Id}
...
[ResourceRequest] api/resource/{Id}
...
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 |
---|
buttonRadius | 20 |
---|
buttonLink | {"link":"https://workbookapi.deltek.com/#adedd734-7010-4eec-b624-d43993867f83","source":"direct"} |
---|
buttonNewLink | |
---|
emojiEnabled | false |
---|
buttonWidth | 20 |
---|
|
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 |
---|
buttonRadius | 20 |
---|
buttonLink | {"link":"https://workbookapi.deltek.com/#9486ebc5-6a96-4695-a53f-489086dcc3d9","source":"direct"} |
---|
buttonNewLink | |
---|
emojiEnabled | false |
---|
buttonWidth | 20 |
---|
|
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 |
---|
buttonRadius | 20 |
---|
buttonLink | {"link":"https://workbookapi.deltek.com/#d059bbf2-56fc-4c0b-83cf-154631a5597b","source":"direct"} |
---|
buttonNewLink | |
---|
emojiEnabled | false |
---|
buttonWidth | 20 |
---|
|
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 |
---|
buttonRadius | 20 |
---|
buttonLink | {"link":"https://workbookapi.deltek.com/#97754d70-fae6-47c4-a06e-bb253aafc4ba","source":"direct"} |
---|
buttonNewLink | |
---|
emojiEnabled | false |
---|
buttonWidth | 20 |
---|
|
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 |
---|
buttonRadius | 20 |
---|
buttonLink | {"link":"https://workbookapi.deltek.com/#946c43a7-1d3c-42c2-9efe-b07d64864216","source":"direct"} |
---|
buttonNewLink | |
---|
emojiEnabled | false |
---|
buttonWidth | 20 |
---|
|
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 |
---|
buttonRadius | 20 |
---|
buttonLink | {"link":"https://workbookapi.deltek.com/#16073aec-c43d-43a6-92bf-46a8d214873e","source":"direct"} |
---|
buttonNewLink | |
---|
emojiEnabled | false |
---|
buttonWidth | 20 |
---|
|
...
ADDITIONAL API INFORMATION
...