Activation Group Subscription

Retrieves An Activation Group Subscription

HTTP Request

GET /api/v1/activation-group-subscription/{id}

📋 Description: Retrieves the details of a specific activation group subscription identified by the provided ID, facilitating the management of lease-related financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

Example Values

Parameter

Example

Type

id

10000004

path

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved activation group subscription

ResponseActivationGroupSubscriptionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 100045,
 8    "topic": {
 9      "enCaption": "Lease Component Updated",
10      "frCaption": "Composant de bail mis à jour",
11      "name": "LEASE_COMPONENT_UPDATED",
12      "priority": "HIGH"
13    },
14    "username": "jdoe",
15    "activationGroupId": 20000123,
16    "activationGroupDisplayId": "AG-100045",
17    "targetId": "jdoe@example.com",
18    "targetType": "USER"
19  }
20}

Update An Activation Group Subscription

HTTP Request

PUT /api/v1/activation-group-subscription/{id}

📋 Description: Updates the subscription details for a specified activation group within the Nakisa Lease Accounting Suite, ensuring accurate management of lease contracts and associated financial obligations. This operation facilitates the maintenance of accounting entries related to lease agreements.

Parameters

Name

In

Type

Required

Description

id

path

integer

true

Unique identifier for the resource

body

body

ActivationGroupSubscriptionDto

false

Request body containing the updated activation group subscription details, including lease and contract information relevant to financial obligations and accounting entries.

Example Values

Parameter

Example

Type

id

10000004

path

Body Parameters

 1{
 2  "id": 100045,
 3  "topic": {
 4    "enCaption": "Lease Component Updated",
 5    "frCaption": "Composant de bail mis à jour",
 6    "name": "LEASE_COMPONENT_UPDATED",
 7    "priority": "HIGH"
 8  },
 9  "username": "jdoe",
10  "activationGroupId": 20000123,
11  "activationGroupDisplayId": "AG-100045",
12  "targetId": "jdoe@example.com",
13  "targetType": "USER"
14}

Responses

Status

Meaning

Description

Schema

200

OK

Activation group subscription successfully updated.

ResponseActivationGroupSubscriptionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 100045,
 8    "topic": {
 9      "enCaption": "Lease Component Updated",
10      "frCaption": "Composant de bail mis à jour",
11      "name": "LEASE_COMPONENT_UPDATED",
12      "priority": "HIGH"
13    },
14    "username": "jdoe",
15    "activationGroupId": 20000123,
16    "activationGroupDisplayId": "AG-100045",
17    "targetId": "jdoe@example.com",
18    "targetType": "USER"
19  }
20}

Create Or Update A Activation Group Subscription

HTTP Request

PUT /api/v1/activation-group-subscription/createOrUpdate

📋 Description: Updates or creates an activation group subscription within the Nakisa Lease Accounting Suite, ensuring accurate alignment of lease contracts and financial obligations for effective accounting entry management.

Parameters

Name

In

Type

Required

Description

body

body

ActivationGroupSubscriptionDto

false

Request body containing the lease and contract subscription details, including financial obligations and accounting entries for activation group management.

Body Parameters

 1{
 2  "id": 100045,
 3  "topic": {
 4    "enCaption": "Lease Component Updated",
 5    "frCaption": "Composant de bail mis à jour",
 6    "name": "LEASE_COMPONENT_UPDATED",
 7    "priority": "HIGH"
 8  },
 9  "username": "jdoe",
10  "activationGroupId": 20000123,
11  "activationGroupDisplayId": "AG-100045",
12  "targetId": "jdoe@example.com",
13  "targetType": "USER"
14}

Responses

Status

Meaning

Description

Schema

200

OK

Successfully created or updated the activation group subscription.

ResponseActivationGroupSubscriptionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": {
 7    "id": 100045,
 8    "topic": {
 9      "enCaption": "Lease Component Updated",
10      "frCaption": "Composant de bail mis à jour",
11      "name": "LEASE_COMPONENT_UPDATED",
12      "priority": "HIGH"
13    },
14    "username": "jdoe",
15    "activationGroupId": 20000123,
16    "activationGroupDisplayId": "AG-100045",
17    "targetId": "jdoe@example.com",
18    "targetType": "USER"
19  }
20}

Creates Or Updates Activation Group Subscription In Bulk

HTTP Request

PUT /api/v1/activation-group-subscription/createOrUpdate/bulk

📋 Description: Creates or updates multiple activation group subscriptions in bulk, facilitating efficient management of lease and contract-related financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

ActivationGroupSubscriptionDto

false

Request body containing bulk data for creating or updating activation group subscriptions, including lease details, contract information, financial obligations, and associated accounting entries.

Body Parameters

 1[
 2  {
 3    "id": 100045,
 4    "topic": {
 5      "enCaption": "Lease Component Updated",
 6      "frCaption": "Composant de bail mis à jour",
 7      "name": "LEASE_COMPONENT_UPDATED",
 8      "priority": "HIGH"
 9    },
10    "username": "jdoe",
11    "activationGroupId": 20000123,
12    "activationGroupDisplayId": "AG-100045",
13    "targetId": "jdoe@example.com",
14    "targetType": "USER"
15  }
16]

Responses

Status

Meaning

Description

Schema

200

OK

Successfully processed all activation group subscriptions.

ResponseListActivationGroupSubscriptionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 100045,
 9      "topic": {
10        "enCaption": "Lease Component Updated",
11        "frCaption": "Composant de bail mis à jour",
12        "name": "LEASE_COMPONENT_UPDATED",
13        "priority": "HIGH"
14      },
15      "username": "jdoe",
16      "activationGroupId": 20000123,
17      "activationGroupDisplayId": "AG-100045",
18      "targetId": "jdoe@example.com",
19      "targetType": "USER"
20    }
21  ]
22}

Update Activation Group Subscription In Bulk

HTTP Request

PUT /api/v1/activation-group-subscription/bulk

📋 Description: Updates multiple activation group subscriptions in bulk, enabling efficient management of lease contracts and financial obligations within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

body

body

ActivationGroupSubscriptionDto

false

Request body containing a collection of activation group subscription details, including lease identifiers and associated financial obligations, for bulk processing within the Nakisa Lease Accounting Suite.

Body Parameters

 1[
 2  {
 3    "id": 100045,
 4    "topic": {
 5      "enCaption": "Lease Component Updated",
 6      "frCaption": "Composant de bail mis à jour",
 7      "name": "LEASE_COMPONENT_UPDATED",
 8      "priority": "HIGH"
 9    },
10    "username": "jdoe",
11    "activationGroupId": 20000123,
12    "activationGroupDisplayId": "AG-100045",
13    "targetId": "jdoe@example.com",
14    "targetType": "USER"
15  }
16]

Responses

Status

Meaning

Description

Schema

200

OK

All activation group subscriptions successfully updated.

ResponseListActivationGroupSubscriptionDto

Example Responses

 1{
 2  "code": "OK",
 3  "errors": {
 4    "all": []
 5  },
 6  "object": [
 7    {
 8      "id": 100045,
 9      "topic": {
10        "enCaption": "Lease Component Updated",
11        "frCaption": "Composant de bail mis à jour",
12        "name": "LEASE_COMPONENT_UPDATED",
13        "priority": "HIGH"
14      },
15      "username": "jdoe",
16      "activationGroupId": 20000123,
17      "activationGroupDisplayId": "AG-100045",
18      "targetId": "jdoe@example.com",
19      "targetType": "USER"
20    }
21  ]
22}

Search Activation Group Subscription

HTTP Request

POST /api/v1/activation-group-subscription/search

📋 Description: Submits a search request for activation group subscriptions, enabling users to efficiently locate relevant lease and contract information related to financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

page

query

integer

false

Zero-based page index (0..N)

size

query

integer

false

The size of the page to be returned

sort

query

array[string]

false

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

body

body

ActivationGroupSubscriptionDtoFilter

false

Request body containing search criteria and filters for lease and contract-related activation group subscriptions, facilitating the identification of relevant financial obligations and accounting entries.

Default Values

Parameter

Default

Type

page

0

query

size

100

query

sort

["createdAt,ASC"]

query

Parameter Constraints

Parameter

Constraints

page

Min: 0

size

Min: 1

Body Parameters

 1{
 2  "idIn": [
 3    101,
 4    102,
 5    103
 6  ],
 7  "idEqual": 101,
 8  "idLike": "SUB-2025",
 9  "createdAtGreaterThanOrEqual": "2025-01-01T00:00:00Z",
10  "createdAtLessThanOrEqual": "2025-12-31T23:59:59Z",
11  "createdByLike": "jdoe",
12  "createdByEqual": "jdoe",
13  "modifiedAtGreaterThanOrEqual": "2025-05-01T00:00:00Z",
14  "modifiedAtLessThanOrEqual": "2025-08-31T23:59:59Z",
15  "modifiedByLike": "asmith",
16  "modifiedByEqual": "asmith",
17  "topicEqual": {
18    "enCaption": "Lease Component Updated",
19    "frCaption": "Composant de bail mis à jour",
20    "name": "LEASE_COMPONENT_UPDATED",
21    "priority": "HIGH"
22  },
23  "usernameLike": "jdoe",
24  "activationGroupIdEqual": 2001,
25  "activationGroupDisplayIdEqual": "AG-2025-001",
26  "activationGroupDisplayIdLike": "AG-2025"
27}

Responses

Status

Meaning

Description

Schema

200

OK

Search results successfully returned.

PageActivationGroupSubscriptionDto

Example Responses

 1{
 2  "totalElements": 76,
 3  "totalPages": 1,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 76,
17  "size": 100,
18  "content": [
19    {
20      "id": 100045,
21      "topic": {
22        "enCaption": "Lease Component Updated",
23        "frCaption": "Composant de bail mis à jour",
24        "name": "LEASE_COMPONENT_UPDATED",
25        "priority": "HIGH"
26      },
27      "username": "jdoe",
28      "activationGroupId": 20000123,
29      "activationGroupDisplayId": "AG-100045",
30      "targetId": "jdoe@example.com",
31      "targetType": "USER"
32    }
33  ],
34  "number": 0,
35  "sort": {
36    "unsorted": false,
37    "sorted": true,
38    "empty": false
39  },
40  "first": true,
41  "last": true,
42  "empty": false
43}

List All Activation Group Subscription

HTTP Request

GET /api/v1/activation-group-subscription

📋 Description: Retrieves activation group subscription details, enabling users to manage lease-related financial obligations and accounting entries within the Nakisa Lease Accounting Suite.

Parameters

Name

In

Type

Required

Description

pageable

query

Pageable

false

Indicates whether the results of the lease activation group subscription query should be returned in a paginated format, facilitating efficient data retrieval for financial obligations and accounting entries.

Responses

Status

Meaning

Description

Schema

200

OK

Successfully retrieved list of activation group subscriptions.

PageActivationGroupSubscriptionDto

Example Responses

 1{
 2  "totalElements": 76,
 3  "totalPages": 1,
 4  "pageable": {
 5    "pageNumber": 0,
 6    "unpaged": false,
 7    "paged": true,
 8    "pageSize": 100,
 9    "offset": 0,
10    "sort": {
11      "unsorted": false,
12      "sorted": true,
13      "empty": false
14    }
15  },
16  "numberOfElements": 76,
17  "size": 100,
18  "content": [
19    {
20      "id": 100045,
21      "topic": {
22        "enCaption": "Lease Component Updated",
23        "frCaption": "Composant de bail mis à jour",
24        "name": "LEASE_COMPONENT_UPDATED",
25        "priority": "HIGH"
26      },
27      "username": "jdoe",
28      "activationGroupId": 20000123,
29      "activationGroupDisplayId": "AG-100045",
30      "targetId": "jdoe@example.com",
31      "targetType": "USER"
32    }
33  ],
34  "number": 0,
35  "sort": {
36    "unsorted": false,
37    "sorted": true,
38    "empty": false
39  },
40  "first": true,
41  "last": true,
42  "empty": false
43}