/Endpoint/rest/api/v1/Connection

18 Dec 2024
6 Minutes to read

Print
Share
Dark
Light

/Endpoint/rest/api/v1/Connection

Updated on 18 Dec 2024
6 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

Use the ConnectionData object resource to create new records.

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 ConnectionData record structure inside the FieldType parameter in the foreign key fields.

Foreign key fields are: ModifiedBy, CreatedBy

Create a new record of Connection

If the value in the Id, Name fields are empty then action insert a new record according input parameter entity record structure (ConnectionData).
If the value in the Name and Id fields are empty then action insert a new record according input parameter entity record structure (ConnectionData).
If the Id, Name field value is matched multiple times, then a 400 error is reported (Errors/Multible Rows), and the error record is returned.

The response body will contain the object of the created record if the call is successful. Method returns an extended Connection 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

Body parameters

Connection information to insert.

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

object

The record of Connection information.

string

The identifier of the module that owns the entity that is being processed.

Name

string Required

Name of connection. The value must be unique in the system and you cannot add multiple values.

Description

string

Description of connection.

ApiKey

string

An API key is a unique identifier used to authenticate a user, developer, or calling program to an API. The pattern of the value (Secure). The default of the value (Generate password).

SecretKey

string

A secret key for signing payloads, enhancing security. The pattern of the value (Secure). The default of the value (Generate password).

URL

string Required

Webhook external service URL-address. The value must be unique in the system and you cannot add multiple values. The pattern of the value (^(http(s)://.)[-a-zA-Z0-9@:%.+~#=]{2,256}.[a-z]{2,6}\b([-a-zA-Z0-9@:%+.~#?&//=]*)$).

Is_Active

boolean

If true, the configuration is active.

Defaultfalse

ExampleFalse

Responses

200

Inserted Connection information.

Expand All

object

The record of Connection information.

string

The identifier of the module that owns the entity that is being processed

Name

string

Name of connection

Description

string

Description of connection

ApiKey

string

An API key is a unique identifier used to authenticate a user, developer, or calling program to an API

SecretKey

string

A secret key for signing payloads, enhancing security.

URL

string

Webhook external service URL-address

Is_Active

boolean

If true, the configuration is active

Defaultfalse

ExampleFalse

Is_System

boolean

If true, the configuration is internal to the system and not visible in the user interface

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

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

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}/Configs