insightly.custom
Module insightly.custom
API
Definitions
![](https://bcentral-packageicons.azureedge.net/images/ballerinax_insightly.custom_1.4.0.png)
ballerinax/insightly.custom Ballerina library
Overview
This is a generated connector for Insightly API v3.1 OpenAPI specification.
This API enables you to integrate Insightly with external systems and applications. This uses HTTPS to access data within the Insightly web application.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Insightly account.
- Obtain tokens by following this guide.
Clients![](/images/permalink.svg)
insightly.custom: Client![](/images/permalink.svg)
This is a generated connector for Insightly API v3.1 OpenAPI specification. This API enables you to integrate Insightly with external systems and applications. This uses HTTPS to access data within the Insightly web application.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create an Insightly Account and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api.insightly.com/v3.1" - URL of the target service
getEntities![](/images/permalink.svg)
function getEntities(string objectName, boolean brief, int? skip, int? top, boolean countTotal) returns CustomObjectsRecords[]|error
Gets a list of records
Parameters
- objectName string - The object name
- brief boolean (default false) - Optional, true if response should only contain top level properties of the record.
- skip int? (default ()) - Optional, number of records to skip.
- top int? (default ()) - Optional, maximum number of records to return in the response.
- countTotal boolean (default false) - Optional,true if total number of records should be returned in the response headers.
Return Type
- CustomObjectsRecords[]|error - Request succeeded.
updateEntity![](/images/permalink.svg)
function updateEntity(string objectName, Customobjectsrecords1 payload) returns CustomObjectsRecords|error
Updates a record
Parameters
- objectName string - The object name
- payload Customobjectsrecords1 - The record to update (just include the JSON object as the request body)
Return Type
- CustomObjectsRecords|error - Request succeeded.
addEntity![](/images/permalink.svg)
function addEntity(string objectName, Customobjectsrecords2 payload) returns CustomObjectsRecords|error
Adds a record
Parameters
- objectName string - The object name
- payload Customobjectsrecords2 - The record to add (just include the JSON object as the request body)
Return Type
- CustomObjectsRecords|error - Request succeeded.
getEntity![](/images/permalink.svg)
function getEntity(string objectName, int id) returns CustomObjectsRecords|error
Gets a record
Return Type
- CustomObjectsRecords|error - Request succeeded.
deleteEntity![](/images/permalink.svg)
Deletes a Record
getTranslation![](/images/permalink.svg)
function getTranslation(string objectName, int id, string language) returns CustomObjectsRecords[]|error
Gets a record's translation in a specific language
Parameters
- objectName string - The object name
- id int - The record's ID
- language string - The requested language
Return Type
- CustomObjectsRecords[]|error - Request succeeded.
updateTranslation![](/images/permalink.svg)
function updateTranslation(string objectName, string language, string id, Customobjectsrecords3 payload) returns CustomObjectsRecords[]|error
Updates a record's translation in a specific language
Parameters
- objectName string - The object name
- language string - The language of the record's translation to update
- id string -
- payload Customobjectsrecords3 - The record to update (just include the JSON object as the request body)
Return Type
- CustomObjectsRecords[]|error - Request succeeded.
addTranslation![](/images/permalink.svg)
function addTranslation(string objectName, string language, string id, CustomObjectsRecords1 payload) returns CustomObjectsRecords[]|error
Adds a Translation for a record in a specific language
Parameters
- objectName string - The object name
- language string - The language of the translation to add
- id string -
- payload CustomObjectsRecords1 - The record to add (just include the JSON object as the request body)
Return Type
- CustomObjectsRecords[]|error - Request succeeded.
getCustomObjectsRecordsBySearch![](/images/permalink.svg)
function getCustomObjectsRecordsBySearch(string objectName, string? fieldName, string? fieldValue, string? updatedAfterUtc, boolean brief, int? skip, int? top, boolean countTotal) returns CustomObjectsRecords[]|error
Gets a filtered list of records
Parameters
- objectName string - The object name
- fieldName string? (default ()) - Optional, field name for object
- fieldValue string? (default ()) - Optional, field value of the record
- updatedAfterUtc string? (default ()) - Optional, earliest date when a record was last updated.
- brief boolean (default false) - Optional, true if response should only contain top level properties of the record.
- skip int? (default ()) - Optional, number of records to skip.
- top int? (default ()) - Optional, maximum number of records to return in the response.
- countTotal boolean (default false) - Optional, true if total number of records should be returned in the response headers.
Return Type
- CustomObjectsRecords[]|error - Request succeeded.
getCustomFields![](/images/permalink.svg)
function getCustomFields(string objectName) returns APICustomFieldMetadata[]|error
Gets a list of Custom Fields
Parameters
- objectName string -
Return Type
- APICustomFieldMetadata[]|error - Request succeeded.
getCustomfieldBySearch![](/images/permalink.svg)
function getCustomfieldBySearch(string objectName, string fieldName) returns CustomFieldMetadata|error
Gets a Custom Field by name
Return Type
- CustomFieldMetadata|error - Request succeeded.
getCustomObjects![](/images/permalink.svg)
function getCustomObjects() returns APICustomObject[]|error
Gets a list of custom objects
Return Type
- APICustomObject[]|error - Request succeeded.
getCustomObject![](/images/permalink.svg)
function getCustomObject(string customObjectName) returns CustomObject|error
Gets a custom object by object name
Parameters
- customObjectName string - The custom object name
Return Type
- CustomObject|error - Request succeeded.
Records![](/images/permalink.svg)
insightly.custom: APICustomField![](/images/permalink.svg)
Fields
- FIELD_NAME string? -
- FIELD_VALUE record {}? -
insightly.custom: APICustomFieldDependency![](/images/permalink.svg)
Fields
- CONTROLLING_FIELD_ID string? -
- OPTIONS_FILTERS APICustomFieldOptionsFilter[]? -
insightly.custom: APICustomFieldMetadata![](/images/permalink.svg)
Fields
- FIELD_NAME string -
- FIELD_ORDER int -
- FIELD_FOR string -
- FIELD_LABEL string -
- FIELD_TYPE string -
- FIELD_HELP_TEXT string? -
- DEFAULT_VALUE string? -
- EDITABLE boolean? -
- VISIBLE boolean? -
- CUSTOM_FIELD_OPTIONS APICustomFieldOption[]? -
- DEPENDENCY APICustomFieldDependency? -
- JOIN_OBJECT string? -
insightly.custom: APICustomFieldOption![](/images/permalink.svg)
Fields
- OPTION_ID int? -
- OPTION_VALUE string -
- OPTION_DEFAULT boolean -
insightly.custom: APICustomFieldOptionsFilter![](/images/permalink.svg)
Fields
- CONTROLLING_VALUE string? -
- OPTION_IDS int[]? -
insightly.custom: APICustomObject![](/images/permalink.svg)
Fields
- OBJECT_NAME string? -
- SINGULAR_LABEL string? -
- PLURAL_LABEL string? -
- DESCRIPTION string? -
- RECORD_NAME_LABEL string? -
- RECORD_NAME_TYPE string? -
- RECORD_NAME_DISPLAY_FORMAT string? -
- ENABLE_NAVBAR boolean? -
- ENABLE_WORKFLOWS boolean? -
- CREATED_USER_ID int? -
- DATE_CREATED_UTC string? -
- DATE_UPDATED_UTC string? -
insightly.custom: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
insightly.custom: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
insightly.custom: CustomFieldMetadata![](/images/permalink.svg)
Fields
- FIELD_NAME string -
- FIELD_ORDER int -
- FIELD_FOR string -
- FIELD_LABEL string -
- FIELD_TYPE string -
- FIELD_HELP_TEXT string? -
- DEFAULT_VALUE string? -
- EDITABLE boolean? -
- VISIBLE boolean? -
- CUSTOM_FIELD_OPTIONS APICustomFieldOption[]? -
- DEPENDENCY APICustomFieldDependency? -
- JOIN_OBJECT string? -
insightly.custom: CustomObject![](/images/permalink.svg)
Fields
- OBJECT_NAME string? -
- SINGULAR_LABEL string? -
- PLURAL_LABEL string? -
- DESCRIPTION string? -
- RECORD_NAME_LABEL string? -
- RECORD_NAME_TYPE string? -
- RECORD_NAME_DISPLAY_FORMAT string? -
- ENABLE_NAVBAR boolean? -
- ENABLE_WORKFLOWS boolean? -
- CREATED_USER_ID int? -
- DATE_CREATED_UTC string? -
- DATE_UPDATED_UTC string? -
insightly.custom: CustomObjectsRecords![](/images/permalink.svg)
Fields
- RECORD_ID int? -
- RECORD_NAME string -
- OWNER_USER_ID int? -
- DATE_CREATED_UTC string? -
- VISIBLE_TO string? -
- VISIBLE_TEAM_ID int? -
- CUSTOMFIELDS APICustomField[]? -
insightly.custom: Customobjectsrecords1![](/images/permalink.svg)
Fields
- RECORD_NAME string -
- OWNER_USER_ID int? -
- VISIBLE_TO string? -
- VISIBLE_TEAM_ID int? -
- CUSTOMFIELDS APICustomField[]? -
insightly.custom: CustomObjectsRecords1![](/images/permalink.svg)
Fields
- RECORD_NAME string -
- OWNER_USER_ID int? -
- VISIBLE_TO string? -
- VISIBLE_TEAM_ID int? -
- CUSTOMFIELDS APICustomField[]? -
insightly.custom: Customobjectsrecords2![](/images/permalink.svg)
Fields
- RECORD_NAME string -
- OWNER_USER_ID int? -
- VISIBLE_TO string? -
- VISIBLE_TEAM_ID int? -
- CUSTOMFIELDS APICustomField[]? -
insightly.custom: Customobjectsrecords3![](/images/permalink.svg)
Fields
- RECORD_NAME string -
- OWNER_USER_ID int? -
- VISIBLE_TO string? -
- VISIBLE_TEAM_ID int? -
- CUSTOMFIELDS APICustomField[]? -
insightly.custom: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
Import
import ballerinax/insightly.custom;
Metadata
Released date: almost 2 years ago
Version: 1.4.0
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.2.1
GraalVM compatible: Yes
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
Sales & CRM/Customer Relationship Management
Cost/Freemium
Contributors