Share via


CobbleStone - Contract Insight (Preview)

Enhance your contract management process by connecting to our Contract Insight API for seamless interaction between systems. Functionality once connected includes: - Creating new records. - Updating existing records. - Pulling a list of records for a given entity. - Pulling all metadata, restrictions and flags. - Pulling a list of editable, updateable, or viewable records.

This connector is available in the following products and regions:

Service Class Regions
Copilot Studio Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name CobbleStone Software
URL https://www.cobblestonesoftware.com
Email AppDev@cobblestonesystems.com
Connector Metadata
Publisher Cobblestone Software
Website https://www.cobblestonesoftware.com
Privacy Policy https://www.cobblestonesoftware.com/company/privacy-policy
Categories Business Management;Sales and CRM

CobbleStone

Allows the basic operations against our Contract Insight software (Add, Insert, Update) and schema information for an entity.

Publisher: CobbleStone Software

Prerequisites

Requires existing license to CobbleStone Software (Contact Insight).

Supported Operations

Get

Pull list of records for a given entity with specific criteria, order by tag, group by tag and number of records. Note: There is no limit on number of records to be pulled but the user has to consider that larger results will be slower to process.

Add

Add a record (limited to one record per call) to specified entity. The response will be the system generated ID.

Update

Update record(s) for a specified entity/area with specific criteria and a TriggerWorkflow as flag to run workflow after the update request succeeds or not. Maximum number of records that can be updated is 500 per call.

Schema

Lists columns, data types, and any restrictions or flags (NULL, Length, Primary Key, etc.) in a table.

List of entities

Returns the list of names and three flagged properties indicating whether it can be edited, updated, or viewed/queried through this interface.

Obtaining Credentials

Authorization (OAUTH 2.0)

Credentials can be setup/generated through your CobbleStone Software system.

Getting Started

To create the API Client credentials through your CobbleStone Software system, use the following steps:

Within your CobbleStone Software system, a system administrator can navigate to the following page to setup/configure credentials:

(NOTE: This is under the "My" top menu item and then select "My API Clients")

This allows a system admin to create OAuth 2.0 credentials (Client ID and Client Secret) for use with the connector.

From logging into your CobbleStone Software system:

To begin, you will open CobbleStone Software and go under My > My API Clients…

image

Create a new API Client entry by clicking Add API Client and give it a unique name. The name is only internal and can be anything meaningful to its purpose. We recommend using a different API key to organize things into small, manageable, and purposeful tasks.

image

This will generate a key and only admin personnel have access to the page. It is bound the the person who generated the key and they are the only one who can see it. You can share they key but only the logged in user can see it.

image

At this point we are done setting up the API Client entry. This Client ID and Client Securet are used for the connector to communicate with your CobbleStone Software system.

Known Issues and Limitations

Currently the connector does not support sending or receiving binary files.

The "Update" endpoint is limited to a max of 500 affected rows per hit. If more then 500 records need to be updated, they need to be processed in multiple hits.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
Client Id - Your CobbleStone ClientId string Please enter the client Id. True
Client Secret - Your CobbleStone ClientSecret securestring Please enter the client secret. True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Create a new a record for a specified entity

Add a record (limited to one record per call) to specified entity. The response will be the system generated ID.

Execute a specific database view

Execute a specific database view (limited to one record per call). The response will be the status.

Pull list of entities that API is allowed to work with

Returns the list of names and three flagged properties indicating whether it can be edited, updated, or viewed/queried.

Pull list of record(s) for a given entity

Pull list of records for a given entity with specific criteria, order by tag, group by tag and number of records. Note: There is no limit on number of records to be pulled but the user has to consider that larger results will be slower to process.

Pull metadata about all columns in specific database view

Lists columns, data types, and any restrictions or flags (NULL, Length, Primary Key, etc.) in a database view.

Pull metadata about all columns in specific entity

Lists columns, data types, and any restrictions or flags (NULL, Length, Primary Key, etc.) in a table.

Retrieve List of available Database Views

Retrieve List of available Database Views of those clients have the permission to query data, internal use for dynamically auto-filling the Database View boxes

Retrieve List of available Entities for Insert Purpose

Retrieve List of available Entities of those clients have the permission to add data, internal use for dynamically auto-filling the list boxes

Retrieve List of available Entities for Select Purpose

Retrieve List of available Entities of those clients have the permission to query data, internal use for dynamically auto-filling the list boxes

Retrieve List of available Entities for Update Purpose

Retrieve List of available Entities of those clients have the permission to update data, internal use for dynamically auto-filling the list boxes

Update record(s) for a specified entity

Update record(s) for a specified entity/area with specific criteria and a TriggerWorkflow as flag to run workflow after the update request succeeds or not. Maximum number of records that can be updated is 500 per call.

Create a new a record for a specified entity

Add a record (limited to one record per call) to specified entity. The response will be the system generated ID.

Parameters

Name Key Required Type Description
Entity Name
entityName True string

Table name name to add record to.

Name
Name string
Value
Value string

Returns

Execute a specific database view

Execute a specific database view (limited to one record per call). The response will be the status.

Parameters

Name Key Required Type Description
Database View Name
databaseViewName True string

Name of the Database View to execute.

Attribute
Attribute string
Alias
Alias string
Condition
Condition string
Field
Field string
ID
ID string
Input
Input string
Operator
Operator string
Condition
Condition string
Field
Field string
ID
ID string
Input
Input string
Operator
Operator string
Type
Type string
Value
Value string
Fields
Fields array of string
Direction
Direction string
GroupByTag
GroupByTag array of string
StartIndex
StartIndex integer

What index to start at, Default = 0

Length
Length integer

Row count starting from StartIndex, cannot excceed 1000, Default = 100

Returns

List of columns, data types, and any restrictions or flags (NULL, Length, Primary Key, etc.) in a table

Pull list of entities that API is allowed to work with

Returns the list of names and three flagged properties indicating whether it can be edited, updated, or viewed/queried.

Returns

List of Entities

Pull list of record(s) for a given entity

Pull list of records for a given entity with specific criteria, order by tag, group by tag and number of records. Note: There is no limit on number of records to be pulled but the user has to consider that larger results will be slower to process.

Parameters

Name Key Required Type Description
Entity Name
entityName True string

Table name to query data from.

Attribute
Attribute string
Alias
Alias string
Condition
Condition string
Field
Field string
ID
ID string
Input
Input string
Operator
Operator string
Condition
Condition string
Field
Field string
ID
ID string
Input
Input string
Operator
Operator string
Type
Type string
Value
Value string
Fields
Fields array of string
Direction
Direction string
GroupByTag
GroupByTag array of string
StartIndex
StartIndex integer

What index to start at, Default = 0

Length
Length integer

Row count starting from StartIndex, cannot excceed 1000, Default = 100

Returns

Pull metadata about all columns in specific database view

Lists columns, data types, and any restrictions or flags (NULL, Length, Primary Key, etc.) in a database view.

Parameters

Name Key Required Type Description
Entity Name
databaseViewName True string

Name of the Database View to retrieve schema for.

Returns

List of columns, data types, and any restrictions or flags (NULL, Length, Primary Key, etc.) in a table

Pull metadata about all columns in specific entity

Lists columns, data types, and any restrictions or flags (NULL, Length, Primary Key, etc.) in a table.

Parameters

Name Key Required Type Description
Entity Name
entityName True string

Name of the Table to retrieve schema for.

Returns

List of columns, data types, and any restrictions or flags (NULL, Length, Primary Key, etc.) in a table

Retrieve List of available Database Views

Retrieve List of available Database Views of those clients have the permission to query data, internal use for dynamically auto-filling the Database View boxes

Returns

Query response for Database Views

Retrieve List of available Entities for Insert Purpose

Retrieve List of available Entities of those clients have the permission to add data, internal use for dynamically auto-filling the list boxes

Returns

List of Entities

Retrieve List of available Entities for Select Purpose

Retrieve List of available Entities of those clients have the permission to query data, internal use for dynamically auto-filling the list boxes

Returns

List of Entities

Retrieve List of available Entities for Update Purpose

Retrieve List of available Entities of those clients have the permission to update data, internal use for dynamically auto-filling the list boxes

Returns

List of Entities

Update record(s) for a specified entity

Update record(s) for a specified entity/area with specific criteria and a TriggerWorkflow as flag to run workflow after the update request succeeds or not. Maximum number of records that can be updated is 500 per call.

Parameters

Name Key Required Type Description
Entity Name
entityName True string

Table name to update record(s) in.

Condition
Condition string
Field
Field string
Id
Id string
Input
Input string
Operator
Operator string
Condition
Condition string
Field
Field string
ID
ID string
Input
Input string
Operator
Operator string
Type
Type string
Value
Value string
Type
Type string
Value
Value string
Name
Name string
Value
Value string
TriggerWorkflow
TriggerWorkflow boolean

Returns

Definitions

APIEntityListResponse

List of Entities

Name Path Type Description
Items
APIEntity

Define each entity

APIEntity

Define each entity

Name Path Type Description
EntityName
EntityName string

Entity name as it is in database

EntityNameDisplay
EntityNameDisplay string

Entity display name

AllowAdd
AllowAdd boolean

Indicates if allowed to add new record

AllowEdit
AllowEdit boolean

Indicates if allowed to edit record(S)

AllowView
AllowView boolean

Indicates if allowed to view record(s)

EntityNameForAPI
EntityNameForAPI string

Entity name that is used in CSS API

APISchemaResponse

List of columns, data types, and any restrictions or flags (NULL, Length, Primary Key, etc.) in a table

Name Path Type Description
Items
APISchema

APISchema

Name Path Type Description
Name
Name string
IsPrimaryKey
IsPrimaryKey boolean
IsIdentity
IsIdentity boolean
IsNullable
IsNullable boolean
DBType
DBType string
MaxLength
MaxLength integer
DataPrecision
DataPrecision integer
DataScale
DataScale integer
HasDefaultValue
HasDefaultValue boolean
IsComputedColumn
IsComputedColumn boolean
IsPassword
IsPassword boolean

APIAddRequestTuple

Name Path Type Description
Name
Name string
Value
Value string

APIUpdateResponse

Name Path Type Description
TotalAffected
TotalAffected integer
TotalFailed
TotalFailed integer
Message
Message string

APIAddRequest

Name Path Type Description
Tuples
Tuples array of APIAddRequestTuple

APIQueryResponse

Name Path Type Description
Items
object

APIViewListResponse

Query response for Database Views

Name Path Type Description
Items
object