/Endpoint/rest/api/v1/Connection/{Id}/Config

18 Dec 2024
8 Minutes to read

Print
Share
Dark
Light

/Endpoint/rest/api/v1/Connection/{Id}/Config

Updated on 18 Dec 2024
8 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/Endpoint/rest/api/v1/Connection/{Id}/Config

Use the ConfigPost object resource to insert or update (Upsert) Config using Id field(s) value.

You can supply the required field values in the request data, and then use the POST method of the resource.

The input parameter must be used in the ConfigData record structure inside the FieldType parameter in the foreign key fields.

Foreign key fields are: WebhookConnectionId, WebhookEntityId, ModifiedBy, CreatedBy

Update a record of Config

If the Id field value is not matched, then a 404 error is reported (Errors/Not Found), and the error record is returned.. You cannot change Id field value (primary key).
When the Id field value is not provided, the system will automatically initiate the insertion of a new record.

Create a new record of Config

If the value in the Id field is empty then action insert a new record according input parameter entity record structure (ConfigData).

The response body will contain the object of the updated or created record if the call is successful. Method returns an extended Config structure. Here, all foreign key fields are abstract object structures, utilizing AbstractText or AbstractLong data types, offering a detailed view of the data and related entities.

Security

OAuth

oAuth autentication flow

FlowClient Credentials

Token URLhttps://dev.esystems.fi/oAuth/rest/v2/Token

Refresh URLhttps://dev.esystems.fi/oAuth/rest/v2/Token

Path parameters

stringRequired

The identifier of the Connection record. The parameter is part of the url address and some special characters are forbidden.

You can extract any string to a base64 string. E.g email address name@domain.com value is base64|bmFtZUBkb21haW4uY29t

Query parameters

Name

string

The name of the database field. If empty, the entity Id field is used.

Example:

Id

Body parameters

Config information to insert or update.

The input parameter must be used in the ConfigData record structure inside the FieldType parameter in the foreign key fields.

Expand All

object

The record of Config information.

string

The identifier of the config.

WebhookEntityId

object (FieldType) Required

The field object structure. This structure allows users to specify any related entity field and its corresponding value. When saving data, the system automatically retrieves and assigns the primary key value from the system database table based on the provided field name and value.

Field

string

The name of the data field. This can be any field name from the related database table, such as 'Email' from the User table or 'Name' from the Department table.

Value

string Required

The value corresponding to the specified data field. This value is used to identify the record in the related database table. For example, it could be an email address, a department name, or an external system's identifier.

HasCreateAccess

boolean

Service has create access to data.

Defaultfalse

ExampleFalse

HasUpdateAccess

boolean

Service has update access to data.

Defaultfalse

ExampleFalse

HasDeleteAccess

boolean

Service has delete access to data.

Defaultfalse

ExampleFalse

Is_Active

boolean

If true, the configuration is active.

Defaultfalse

ExampleFalse

ModifiedBy

object (FieldType)

Field

string

The name of the data field. This can be any field name from the related database table, such as 'Email' from the User table or 'Name' from the Department table.

Value

string Required

ModifiedOn

string (date-time)

The date the record was updated.

Default"1900-01-01T12:00:00Z"

Example1900-01-01T12:00:00Z

CreatedBy

object (FieldType)

Field

string

The name of the data field. This can be any field name from the related database table, such as 'Email' from the User table or 'Name' from the Department table.

Value

string Required

CreatedOn

string (date-time)

The date the record was created.

Default"1900-01-01T12:00:00Z"

Example1900-01-01T12:00:00Z

Responses

200

Inserted or updated Config information.

Expand All

object

The record of Config information.

string

The identifier of the config

WebhookEntityId

object (AbstractText1)

This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.

string

The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5

ExternalId

string

An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5

Name

string

The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

ExampleBob Normal

Type

string

The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

ExampleUser

HasCreateAccess

boolean

Service has create access to data

Defaultfalse

ExampleFalse

HasUpdateAccess

boolean

Service has update access to data

Defaultfalse

ExampleFalse

HasDeleteAccess

boolean

Service has delete access to data

Defaultfalse

ExampleFalse

Is_Active

boolean

If true, the configuration is active

Defaultfalse

ExampleFalse

ModifiedBy

object (AbstractLong1)

This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities.

integer (int64)

The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

Default0

Example1234567891234567

ExternalId

string

An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5

Name

string

ExampleBob Normal

Type

string

The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

ExampleUser

ModifiedOn

string (date-time)

The date the record was updated.

Default"1900-01-01T12:00:00Z"

Example1900-01-01T12:00:00Z

CreatedBy

object (AbstractLong1)

This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities.

integer (int64)

The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

Default0

Example1234567891234567

ExternalId

string

An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5

Name

string

ExampleBob Normal

Type

string

The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

ExampleUser

CreatedOn

string (date-time)

The date the record was created.

Default"1900-01-01T12:00:00Z"

Example1900-01-01T12:00:00Z

400

Bad Request - The user has provided input that the browser is unable to convert.

{
  "Errors": [
    "The user has provided input that the browser is unable to convert.",
    "There are multiple rows in the database for the same value",
    "The value does not match the specified entity structure",
    "..."
  ],
  "Type": "/Errors/Bad Input",
  "Title": "Bad Request",
  "StatusCode": 400,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}

object

The list of errors. Throw specific exceptions based on the received error.

Errors

Array of string

Human-readable explanation of the errors

string

Default""

Type

string

URI identifier that categorizes the error

Default""

Title

string

Brief, human-readable message about the error

Default""

StatusCode

integer (int32)

The HTTP response code

Example400

Instance

string

URI that identifies the specific occurrence of the error

Default""

RequestKey

string

Provides a request key that identifies the current request.

Default""

401

Unauthorized - The response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

{
  "Errors": [
    "The session Id or OAuth token used has expired or is invalid."
  ],
  "Type": "/Errors/Unauthorized",
  "Title": "Unauthorized",
  "StatusCode": 401,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}

object

The list of errors. Throw specific exceptions based on the received error.

Errors

Array of string

Human-readable explanation of the errors

string

Default""

Type

string

URI identifier that categorizes the error

Default""

Title

string

Brief, human-readable message about the error

Default""

StatusCode

integer (int32)

The HTTP response code

Example400

Instance

string

URI that identifies the specific occurrence of the error

Default""

RequestKey

string

Provides a request key that identifies the current request.

Default""

403

Forbidden - The user does not have access to execute operation

{
  "Errors": [
    "The user does not have access to execute operation"
  ],
  "Type": "/Errors/Permission",
  "Title": "Bad Request",
  "StatusCode": 403,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}

object

The list of errors. Throw specific exceptions based on the received error.

Errors

Array of string

Human-readable explanation of the errors

string

Default""

Type

string

URI identifier that categorizes the error

Default""

Title

string

Brief, human-readable message about the error

Default""

StatusCode

integer (int32)

The HTTP response code

Example400

Instance

string

URI that identifies the specific occurrence of the error

Default""

RequestKey

string

Provides a request key that identifies the current request.

Default""

500

Internal Server Error - An internal server error is an error on the web server you're trying to access.

{
  "Errors": [
    "An internal server error is an error on the web server you're trying to access."
  ],
  "Type": "/Errors/Internal Server Error",
  "Title": "Internal Server Error",
  "StatusCode": 500,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}

object

The list of errors. Throw specific exceptions based on the received error.

Errors

Array of string

Human-readable explanation of the errors

string

Default""

Type

string

URI identifier that categorizes the error

Default""

Title

string

Brief, human-readable message about the error

Default""

StatusCode

integer (int32)

The HTTP response code

Example400

Instance

string

URI that identifies the specific occurrence of the error

Default""

RequestKey

string

Provides a request key that identifies the current request.

Default""

Was this article helpful?

What's Next

/Endpoint/rest/api/v1/Connection/{Id}/Config/{SubId}