Projects - INSTALINK.io
Sign In

Projects

_id
name
accountId
connectorId
versionNumber
active
isPublic
basePath
revisionIdentifier
createdTime
modifiedTime
processes
accounts
connector
processIds
projectConditions
projectTransforms
projectFields
projectQueryFields
projectAuthorizations
processAuthorizations
databaseConnections
projectVariables
acceptedFiles
projectConnectors
projectSecrets
messageAttachments
systemWarnings
processDescriptions
examples

_id (Primary Key) objectid

The unique identifier for the record

Requires a Non-Null ValueYes

name Name string

The name of the project.

Requires a Non-Null ValueYes
Default Value""
Trims WhitespaceNo
HTML Tags AllowedNo
Converts to LowercaseNo
Converts to UppercaseNo

accountId Account objectid

The account that owns the project.

Requires a Non-Null ValueYes

connectorId Connector objectid

undefined

Requires a Non-Null ValueNo

versionNumber Version string

The identifier that declares the version of the project within a connector. Multiple projects of the same name may exist within the connector. Projects with higher version numbers are considered to be the latest versions used within the connector.

Requires a Non-Null ValueYes
Default Value"0.0.0"
Trims WhitespaceNo
HTML Tags AllowedNo
Converts to LowercaseNo
Converts to UppercaseNo

active Active boolean

When enabled the project will deploy to the Instalink servers. Disable this to prevent the project from executing.

Requires a Non-Null ValueYes
Default ValueYes

isPublic Is Public boolean

When the project is a part of a connector and this is enabled, the version of the project will be available to all Instalink users.

Requires a Non-Null ValueYes
Default ValueNo

basePath Base Path string

Requires a Non-Null ValueNo
Trims WhitespaceNo
HTML Tags AllowedNo
Converts to LowercaseNo
Converts to UppercaseNo

revisionIdentifier Build Number integer

Requires a Non-Null ValueYes
Default Value1

createdTime datetime

System managed property. Set to the timestamp of when the record is created.

Requires a Non-Null ValueYes
Default Value__auto__

modifiedTime datetime

System managed property. Set to the timestamp of when the record is updated.

Requires a Non-Null ValueYes
Default Value__auto__

processes Processes join

All processes that the project contains.

Data Modelprocesses
Local Propertyprojects._id
Foreign Propertyprocesses.projectId

accounts join

A reference to the account that owns the project.

Data Modelaccounts
Local Propertyprojects.accountId
Foreign Propertyaccounts._id

connector Connector join

The connector that the project may be a member of. Connectors are used to share data flows between accounts and projects.

Data Modelconnectors
Local Propertyprojects.connectorId
Foreign Propertyconnectors._id

processIds join

All processes that the project contains. Only returns the reference IDs.

Data Modelprocesses
Local Propertyprojects._id
Foreign Propertyprocesses.projectId

projectConditions join

All data conditionals that are owned by the project.

Data Modelprocesses
Local Propertyprojects._id
Foreign Propertyprocesses.projectId

projectTransforms join

All data transformations that are owned by the project.

Data Modelprocesses
Local Propertyprojects._id
Foreign Propertyprocesses.projectId

projectFields join

All field records that are owned by the project.

Data Modelprocesses
Local Propertyprojects._id
Foreign Propertyprocesses.projectId

projectQueryFields join

All database query field records that are owned by the project.

Data Modelprocesses
Local Propertyprojects._id
Foreign Propertyprocesses.projectId

projectAuthorizations join

All authorization records that are owned by the project. These authorization records may be used with inbound or outbound calls to permission access.

Data ModelprojectAuthorizations
Local Propertyprojects._id
Foreign PropertyprojectAuthorizations.projectId

processAuthorizations join

Data ModelprocessAuthorizations
Local Propertyprojects._id
Foreign PropertyprocessAuthorizations.projectId

databaseConnections join

All database connection records that are owned by the project. The database connection record contains the information required to establish a connection with a remote database service.

Data ModeldatabaseConnections
Local Propertyprojects._id
Foreign PropertydatabaseConnections.projectId
Properties
Project (projectId)  
Account (accountId)  
Connection Name (name)  
Engine (engine)  
Host (host)  
Port (port)  
User (user)  
Password (password)  
Options (query string) (options)  
Database Name (databaseName)  
SQL Request Timeout (in milliseconds) (requestTimeout)  

projectVariables join

All project variables owned by the project. Project variables establish default properties that are included in the process data of all data flows contained within the project.

Data ModelprojectVariables
Local Propertyprojects._id
Foreign PropertyprojectVariables.projectId
Properties
Project (projectId)  
Account (accountId)  
Key (key)  
Value (value)  

acceptedFiles join

All accepted file records owned by the project. Accepted file records are descriptors of what files are allowed to be submitted to inbound request actions.

Data ModelacceptedFiles
Local Propertyprojects._id
Foreign PropertyacceptedFiles.projectId

projectConnectors join

All connectors that the project has access to utilize within it's own data flows.

Data ModelprojectConnectors
Local Propertyprojects._id
Foreign PropertyprojectConnectors.projectId
Properties
Project (projectId)  
Account (accountId)  
Connector (connectorId)  
Version (connectorVersionId)  

projectSecrets join

Data ModelprojectSecrets
Local Propertyprojects._id
Foreign PropertyprojectSecrets.projectId
Properties
Project (projectId)  
Account (accountId)  
Label (label)  
Type (secretType)  
Value (data)  
SSH Passphrase (sshPassphrase)  

messageAttachments join

Data ModelmessageAttachments
Local Propertyprojects._id
Foreign PropertymessageAttachments.projectId

systemWarnings join

Data ModelsystemWarnings
Local Propertyprojects._id
Foreign PropertysystemWarnings.projectId

processDescriptions join

Data Modelprocesses
Local Propertyprojects._id
Foreign Propertyprocesses.projectId

examples join

Data Modelexamples
Local Propertyprojects._id
Foreign Propertyexamples.projectId