Versions Compared

Key

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

WORKBOOK API

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

To see the available endpoints, you can visit open a browser and type in [your WorkBook URL]/api/custommetadata on your site and , it includes a search area and a standard verb filter. An example of this would be https://tangramtangramdemo.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 team system administrator or Tangram team support if you don’t have access to this area as seen below; you must have administrator access within WorkBook to set this setting.

  • 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 

Child pages (Children Display)

...

ADDITIONAL API INFORMATION

For additional API information refer to the articles below.

Child pages (Children Display)