Introduction to REST API
About REST API in general
Principles of REST API
REST API Methods
About the Planon REST API
Time zones
Property date-time
Transaction date-time
Neutral date-time
Daylight saving time
Prerequisites
License
Navigation panel
Security
User access
Basic features
User interface
Definitions level
Field definitions level
License usage level
Which BOs and Fields can be used in REST API calls?
BOs that are allowed to be used
Fields that are allowed to be used
Creating definitions
Single level definition
Multi-level definition
Using definitions
Generate and import an OpenAPI document
Creating a sample request
OpenAPI document
OPENAPI property
INFO object
SERVERS object
SECURITY object
PATHS object
Examples of endpoints
Create
Read
Lookup
Update
Delete
ChangeState
Retrieve / Download file
Attach / Upload file
Detailed information on the request body
Filters in the body
Values in the body
Answers in the body
Dealing with warnings
Dealing with confirmations
Arguments in the body
Advanced features
File handling
Remove file
Attributes on Assets
Attaching an attribute set
Detaching an attribute set
Setting attribute values
Reading attribute values
Removing attribute values
Batch processing
Request header
Endpoint patterns
Read endpoint
Update endpoint
Delete endpoint
Execute endpoint
Lookup endpoint
ChangeState endpoint
OpenAPI endpoint
Batch endpoint
Download endpoint
Upload endpoint