NEW: Check our new hosted service COZYROC Cloud ...
PlanGrid Connection
Overview
Configuration is provided for establishing connections with PlanGrid service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Configuration
The provided configuration handles the authentication aspect of communicating with the service. To invoke endpoints, specific to you integration needs, consider defining custom resources (to be used with REST Source and/or REST Destination) or use the REST Web Service Request Task. If you have suggestions for further improvements, we will be happy to hear your feedback.
Download the configuration from here. Then review the KB article posted here how to use the configuration.
Base URL address: https://io.plangrid.com.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- client_id:
- client_secret:
- scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}} -
Accept:
application/vnd.plangrid+json; version=1
For further information, please check here.
- Basic
-
The authentication uses a parameters-based authentication.
The authentication has the following user-defined parameters:
- APIKey: Required. Specify API key.
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Basic {{=Base64.encode(connection.user.APIKey + ':')}} -
Accept:
application/vnd.plangrid+json; version=1
For further information, please check here.
Template Fields define custom and/or compound data types to enable flexible modelling of entities' fields.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE Before setting, the value is processed with
{{=value && dateFormat(value, 'yyyy-mm-dd')}}expression.
Template Resources enable the reuse of fields and actions across multiple resources.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
skip:
{{=parameters.iterator}} -
limit:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
skip:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.The following request parameters will be automatically processed:
-
application/json:
{{=item}}
-
application/json:
- type
Template: ShortText. A read-only field.
- revision
A key field. Data type: DT_I4
- created_at
Template: DateTime. A read-only field.
- updated_at
Template: DateTime. A read-only field.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.