Applications

PreviousMappings NextApplicationPermissions

Was this helpful?

Soft Delete Application

delete

Soft delete a specific Application by setting is_active=False instead of removing the record.

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

No Content - Application deactivated successfully

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

delete

DELETE /api/v1/applications/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

List Applications

get

List all Applications

Authorizations

Query parameters

pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1

limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10

namestringOptional

Filters by name

application_typestring · enumOptional

Filter by application type

Example: commercePossible values:

is_activebooleanOptional

Filter by active status (True or False)

name__containsstringOptional

Filter by name containing the given string

name__icontainsstringOptional

Filter by name case-insensitive containing the given string

related_application_id__iexactstringOptional

Filter by related application ID (case-insensitive exact match)

Responses

200

List of Applications

application/json

401

Unauthorized Access

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

GET /api/v1/applications/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "Test Application",
    "application_type": "sales-channel",
    "config": {
      "web_url": "https://application-test.akinon.net/",
      "visible_type": "empty",
      "client_path": "test/path"
    },
    "is_active": true,
    "remote_object_id": 1234,
    "created_by": 5,
    "is_visible": false,
    "is_proxy_available": true,
    "related_application_id": "app-4567",
    "created_date": "2024-01-01T12:00:00Z",
    "modified_date": "2024-01-02T12:00:00Z"
  }
]

Retrieve Application

get

Retrieve a specific Application by ID

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Application retrieved successfully

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

get

GET /api/v1/applications/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "name": "Test Application",
  "application_type": "sales-channel",
  "config": {
    "web_url": "https://application-test.akinon.net/",
    "visible_type": "empty",
    "client_path": "test/path"
  },
  "is_active": true,
  "remote_object_id": 1234,
  "created_by": 5,
  "is_visible": false,
  "is_proxy_available": true,
  "related_application_id": "app-4567",
  "created_date": "2024-01-01T12:00:00Z",
  "modified_date": "2024-01-02T12:00:00Z"
}

Update Application

put

Update a specific Application by ID

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

idintegerOptionalExample: 1

namestring · max: 100RequiredExample: Test Application

application_typestring · enumRequired

Enum value for the type of application

Example: sales-channelPossible values:

is_activebooleanRequiredDefault: trueExample: true

remote_object_idinteger | nullableOptionalExample: 1234

created_byinteger | nullableOptional

ID of the user who created the application

Example: 5

is_visiblebooleanRequired

Default value is False. is_visible determines if the application should be visible on the user interface (Omnitron FE). The application will be visible if this flag is set to True.

Default: falseExample: false

is_proxy_availablebooleanRequired

Specifies whether requests to the api/v1/app_proxy/ endpoint should be forwarded to the related application via proxy. Default value is False. If set to False, no proxy forwarding is done, and users receive an HTTP 404. If is_proxy_available=True, requests are forwarded to the application's web_url in the config.

Default: falseExample: true

related_application_idstring | nullableOptional

The related_application_id field stores the associated extension ID from ACC for the Omnitron application. It can be filtered using the related_application_id__iexact parameter, and it accepts up to 255 characters.

Example: app-4567

created_datestring · date-timeOptional

The date and time when the application was created

Example: 2024-01-01T12:00:00Z

modified_datestring · date-timeOptional

The date and time when the application was last modified

Example: 2024-01-02T12:00:00Z

Responses

200

Application updated successfully

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

put

PUT /api/v1/applications/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 392

{
  "id": 1,
  "name": "Test Application",
  "application_type": "sales-channel",
  "config": {
    "web_url": "https://application-test.akinon.net/",
    "visible_type": "empty",
    "client_path": "test/path"
  },
  "is_active": true,
  "remote_object_id": 1234,
  "created_by": 5,
  "is_visible": false,
  "is_proxy_available": true,
  "related_application_id": "app-4567",
  "created_date": "2024-01-01T12:00:00Z",
  "modified_date": "2024-01-02T12:00:00Z"
}

No content

Partial Update Application

patch

Partial update a specific Application by ID

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

idintegerOptionalExample: 1

namestring · max: 100RequiredExample: Test Application

application_typestring · enumRequired

Enum value for the type of application

Example: sales-channelPossible values:

is_activebooleanRequiredDefault: trueExample: true

remote_object_idinteger | nullableOptionalExample: 1234

created_byinteger | nullableOptional

ID of the user who created the application

Example: 5

is_visiblebooleanRequired

Default value is False. is_visible determines if the application should be visible on the user interface (Omnitron FE). The application will be visible if this flag is set to True.

Default: falseExample: false

is_proxy_availablebooleanRequired

Default: falseExample: true

related_application_idstring | nullableOptional

Example: app-4567

created_datestring · date-timeOptional

The date and time when the application was created

Example: 2024-01-01T12:00:00Z

modified_datestring · date-timeOptional

The date and time when the application was last modified

Example: 2024-01-02T12:00:00Z

Responses

200

Application partially updated successfully

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch

PATCH /api/v1/applications/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 392

{
  "id": 1,
  "name": "Test Application",
  "application_type": "sales-channel",
  "config": {
    "web_url": "https://application-test.akinon.net/",
    "visible_type": "empty",
    "client_path": "test/path"
  },
  "is_active": true,
  "remote_object_id": 1234,
  "created_by": 5,
  "is_visible": false,
  "is_proxy_available": true,
  "related_application_id": "app-4567",
  "created_date": "2024-01-01T12:00:00Z",
  "modified_date": "2024-01-02T12:00:00Z"
}

No content

Create Application

post

Creates a new Application object.

Authorizations

Body

idintegerOptionalExample: 1

namestring · max: 100RequiredExample: Test Application

application_typestring · enumRequired

Enum value for the type of application

Example: sales-channelPossible values:

is_activebooleanRequiredDefault: trueExample: true

remote_object_idinteger | nullableOptionalExample: 1234

created_byinteger | nullableOptional

ID of the user who created the application

Example: 5

is_visiblebooleanRequired

Default value is False. is_visible determines if the application should be visible on the user interface (Omnitron FE). The application will be visible if this flag is set to True.

Default: falseExample: false

is_proxy_availablebooleanRequired

Default: falseExample: true

related_application_idstring | nullableOptional

Example: app-4567

created_datestring · date-timeOptional

The date and time when the application was created

Example: 2024-01-01T12:00:00Z

modified_datestring · date-timeOptional

The date and time when the application was last modified

Example: 2024-01-02T12:00:00Z

Responses

201

Country Created

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

POST /api/v1/applications/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 392

{
  "id": 1,
  "name": "Test Application",
  "application_type": "sales-channel",
  "config": {
    "web_url": "https://application-test.akinon.net/",
    "visible_type": "empty",
    "client_path": "test/path"
  },
  "is_active": true,
  "remote_object_id": 1234,
  "created_by": 5,
  "is_visible": false,
  "is_proxy_available": true,
  "related_application_id": "app-4567",
  "created_date": "2024-01-01T12:00:00Z",
  "modified_date": "2024-01-02T12:00:00Z"
}

{
  "id": 1,
  "name": "Test Application",
  "application_type": "sales-channel",
  "config": {
    "web_url": "https://application-test.akinon.net/",
    "visible_type": "empty",
    "client_path": "test/path"
  },
  "is_active": true,
  "remote_object_id": 1234,
  "created_by": 5,
  "is_visible": false,
  "is_proxy_available": true,
  "related_application_id": "app-4567",
  "created_date": "2024-01-01T12:00:00Z",
  "modified_date": "2024-01-02T12:00:00Z"
}