Unable to render embedded object: File (Teach_Centre_Navy.png) not found.

Skip to end of banner
Go to start of banner

WORKBOOK API > API Overview

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

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.

To see 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.


JAVASCRIPT & API

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

You must have administrator access to access this setting. Consult your system administrator or Tangram support if you don’t have access to this area as seen below.

  • 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} 

  • [ResourcesRequest] /api/resources 


ADDITIONAL API INFORMATION

For additional API information refer to the articles below.

  • No labels