Enums

Enums - Get

HTTP Request

GET /api/v1/enums/{id}

Interactive Demo

📋 Description: Retrieves the details of a specific enumeration by its unique identifier, enabling users to access and utilize predefined values within the application.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseNotificationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "subscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    },
    "unsubscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE"
    },
    "scheduledTime": "2019-08-24T14:15:22Z",
    "user": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "state": "ACTIVE",
    "status": "UNREAD"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Enums - Update

HTTP Request

PUT /api/v1/enums/{id}

Interactive Demo

📋 Description: Updates the specified enumeration identified by the provided ID, allowing for modifications to its attributes to reflect current business requirements.

Parameters

Name	In	Type	Required	Description
id	path	integer(int64)	true	Unique identifier for the resource
body	body	NotificationDto	true	Request body containing the updated enumeration details, including relevant attributes and metadata for the specified ID.

Body Parameters

{
  "id": 0,
  "subscribeMessage": {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE",
    "captionKey": "string",
    "en_message": "string",
    "fr_message": "string",
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "dataType": "NUMBER",
        "value": "string"
      }
    ],
    "onlyAfterNow": true,
    "startTime": "2019-08-24T14:15:22Z",
    "cronExpression": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "content": "string"
  },
  "unsubscribeMessage": {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE"
  },
  "scheduledTime": "2019-08-24T14:15:22Z",
  "user": {
    "id": 0,
    "accountId": 0,
    "fullName": "string",
    "firstName": "string",
    "lastName": "string",
    "username": "string",
    "email": "string",
    "accountName": "string",
    "profile": "string"
  },
  "state": "ACTIVE",
  "status": "UNREAD"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseNotificationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "subscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    },
    "unsubscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE"
    },
    "scheduledTime": "2019-08-24T14:15:22Z",
    "user": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "state": "ACTIVE",
    "status": "UNREAD"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Enums - Create Or Update Bulk

HTTP Request

PUT /api/v1/enums/createOrUpdate/bulk

Interactive Demo

📋 Description: Creates or updates multiple enumeration records in bulk, streamlining data management and ensuring consistency across the system.

Parameters

Name	In	Type	Required	Description
body	body	NotificationDto	true	Request body containing an array of enum objects for bulk creation or updates, including relevant attributes and metadata to ensure accurate processing.

Body Parameters

[
  {
    "id": 0,
    "subscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    },
    "unsubscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE"
    },
    "scheduledTime": "2019-08-24T14:15:22Z",
    "user": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "state": "ACTIVE",
    "status": "UNREAD"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListNotificationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "subscribeMessage": {
        "id": 0,
        "targetId": "string",
        "targetType": "string",
        "topicApplication": "NFS",
        "topicName": "string",
        "topicPriority": "HIGH",
        "topicEnCaption": "string",
        "topicFrCaption": "string",
        "username": "string",
        "action": "SUBSCRIBE",
        "captionKey": "string",
        "en_message": "string",
        "fr_message": "string",
        "url": "string",
        "parameters": [
          {
            "name": "string",
            "dataType": "NUMBER",
            "value": "string"
          }
        ],
        "onlyAfterNow": true,
        "startTime": "2019-08-24T14:15:22Z",
        "cronExpression": "string",
        "endTime": "2019-08-24T14:15:22Z",
        "content": "string"
      },
      "unsubscribeMessage": {
        "id": 0,
        "targetId": "string",
        "targetType": "string",
        "topicApplication": "NFS",
        "topicName": "string",
        "topicPriority": "HIGH",
        "topicEnCaption": "string",
        "topicFrCaption": "string",
        "username": "string",
        "action": "SUBSCRIBE"
      },
      "scheduledTime": "2019-08-24T14:15:22Z",
      "user": {
        "id": 0,
        "accountId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "username": "string",
        "email": "string",
        "accountName": "string",
        "profile": "string"
      },
      "state": "ACTIVE",
      "status": "UNREAD"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Enums - Create Or Update

HTTP Request

PUT /api/v1/enums/createOrUpdate

Interactive Demo

📋 Description: Creates or updates enumeration values in the system, ensuring that the latest definitions are accurately reflected for business processes.

Parameters

Name	In	Type	Required	Description
body	body	NotificationDto	true	Request body containing the enumeration data to be created or updated, including relevant identifiers and attributes for effective management.

Body Parameters

{
  "id": 0,
  "subscribeMessage": {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE",
    "captionKey": "string",
    "en_message": "string",
    "fr_message": "string",
    "url": "string",
    "parameters": [
      {
        "name": "string",
        "dataType": "NUMBER",
        "value": "string"
      }
    ],
    "onlyAfterNow": true,
    "startTime": "2019-08-24T14:15:22Z",
    "cronExpression": "string",
    "endTime": "2019-08-24T14:15:22Z",
    "content": "string"
  },
  "unsubscribeMessage": {
    "id": 0,
    "targetId": "string",
    "targetType": "string",
    "topicApplication": "NFS",
    "topicName": "string",
    "topicPriority": "HIGH",
    "topicEnCaption": "string",
    "topicFrCaption": "string",
    "username": "string",
    "action": "SUBSCRIBE"
  },
  "scheduledTime": "2019-08-24T14:15:22Z",
  "user": {
    "id": 0,
    "accountId": 0,
    "fullName": "string",
    "firstName": "string",
    "lastName": "string",
    "username": "string",
    "email": "string",
    "accountName": "string",
    "profile": "string"
  },
  "state": "ACTIVE",
  "status": "UNREAD"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseNotificationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": {
    "id": 0,
    "subscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    },
    "unsubscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE"
    },
    "scheduledTime": "2019-08-24T14:15:22Z",
    "user": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "state": "ACTIVE",
    "status": "UNREAD"
  }
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Enums - Bulk Update

HTTP Request

PUT /api/v1/enums/bulk

Interactive Demo

📋 Description: Updates multiple enumeration values in bulk, allowing for efficient management of categorical data within the system.

Parameters

Name	In	Type	Required	Description
body	body	NotificationDto	true	Request body containing an array of enumeration objects for bulk creation or updates, ensuring efficient management of categorical data within the system.

Body Parameters

[
  {
    "id": 0,
    "subscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE",
      "captionKey": "string",
      "en_message": "string",
      "fr_message": "string",
      "url": "string",
      "parameters": [
        {
          "name": "string",
          "dataType": "NUMBER",
          "value": "string"
        }
      ],
      "onlyAfterNow": true,
      "startTime": "2019-08-24T14:15:22Z",
      "cronExpression": "string",
      "endTime": "2019-08-24T14:15:22Z",
      "content": "string"
    },
    "unsubscribeMessage": {
      "id": 0,
      "targetId": "string",
      "targetType": "string",
      "topicApplication": "NFS",
      "topicName": "string",
      "topicPriority": "HIGH",
      "topicEnCaption": "string",
      "topicFrCaption": "string",
      "username": "string",
      "action": "SUBSCRIBE"
    },
    "scheduledTime": "2019-08-24T14:15:22Z",
    "user": {
      "id": 0,
      "accountId": 0,
      "fullName": "string",
      "firstName": "string",
      "lastName": "string",
      "username": "string",
      "email": "string",
      "accountName": "string",
      "profile": "string"
    },
    "state": "ACTIVE",
    "status": "UNREAD"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	OK	ResponseListNotificationDto

Example Responses

{
  "code": "UPDATED",
  "errors": {
    "all": [
      {
        "type": "GENERIC",
        "errorMessage": "string",
        "source": {},
        "field": "string",
        "errorKey": "string"
      }
    ]
  },
  "object": [
    {
      "id": 0,
      "subscribeMessage": {
        "id": 0,
        "targetId": "string",
        "targetType": "string",
        "topicApplication": "NFS",
        "topicName": "string",
        "topicPriority": "HIGH",
        "topicEnCaption": "string",
        "topicFrCaption": "string",
        "username": "string",
        "action": "SUBSCRIBE",
        "captionKey": "string",
        "en_message": "string",
        "fr_message": "string",
        "url": "string",
        "parameters": [
          {
            "name": "string",
            "dataType": "NUMBER",
            "value": "string"
          }
        ],
        "onlyAfterNow": true,
        "startTime": "2019-08-24T14:15:22Z",
        "cronExpression": "string",
        "endTime": "2019-08-24T14:15:22Z",
        "content": "string"
      },
      "unsubscribeMessage": {
        "id": 0,
        "targetId": "string",
        "targetType": "string",
        "topicApplication": "NFS",
        "topicName": "string",
        "topicPriority": "HIGH",
        "topicEnCaption": "string",
        "topicFrCaption": "string",
        "username": "string",
        "action": "SUBSCRIBE"
      },
      "scheduledTime": "2019-08-24T14:15:22Z",
      "user": {
        "id": 0,
        "accountId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "username": "string",
        "email": "string",
        "accountName": "string",
        "profile": "string"
      },
      "state": "ACTIVE",
      "status": "UNREAD"
    }
  ]
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Enums - Search

HTTP Request

POST /api/v1/enums/search

Interactive Demo

📋 Description: Submits a search request to retrieve a list of enumerated values based on specified criteria, facilitating efficient data categorization and retrieval for business applications.

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	NotificationExtendedDtoFilter	false	Request body containing search criteria for enumerations, including filters and parameters to refine the results based on business needs.

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

{
  "idIn": [
    0
  ],
  "idEqual": 0,
  "idLike": "string",
  "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "createdByLike": "string",
  "createdByEqual": "string",
  "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
  "modifiedByLike": "string",
  "modifiedByEqual": "string",
  "scheduledTimeLessThan": "2019-08-24T14:15:22Z",
  "stateEqual": "ACTIVE",
  "statusEqual": "UNREAD",
  "usernameIn": [
    "string"
  ],
  "targetIdEqual": "string",
  "targetTypeEqual": "string",
  "applicationEqual": "NFS",
  "topicPriorityEqual": "HIGH",
  "topicNameEqual": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageNotificationDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "subscribeMessage": {
        "id": 0,
        "targetId": "string",
        "targetType": "string",
        "topicApplication": "NFS",
        "topicName": "string",
        "topicPriority": "HIGH",
        "topicEnCaption": "string",
        "topicFrCaption": "string",
        "username": "string",
        "action": "SUBSCRIBE",
        "captionKey": "string",
        "en_message": "string",
        "fr_message": "string",
        "url": "string",
        "parameters": [
          {
            "name": "string",
            "dataType": "NUMBER",
            "value": "string"
          }
        ],
        "onlyAfterNow": true,
        "startTime": "2019-08-24T14:15:22Z",
        "cronExpression": "string",
        "endTime": "2019-08-24T14:15:22Z",
        "content": "string"
      },
      "unsubscribeMessage": {
        "id": 0,
        "targetId": "string",
        "targetType": "string",
        "topicApplication": "NFS",
        "topicName": "string",
        "topicPriority": "HIGH",
        "topicEnCaption": "string",
        "topicFrCaption": "string",
        "username": "string",
        "action": "SUBSCRIBE"
      },
      "scheduledTime": "2019-08-24T14:15:22Z",
      "user": {
        "id": 0,
        "accountId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "username": "string",
        "email": "string",
        "accountName": "string",
        "profile": "string"
      },
      "state": "ACTIVE",
      "status": "UNREAD"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Enums - Get Supported Languages

HTTP Request

GET /api/v1/enums/supported-languages

Interactive Demo

📋 Description: Retrieves a list of supported languages for the application, enabling users to understand localization options available for their business needs.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "ENGLISH"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Enums - Get Notification Priorities

HTTP Request

GET /api/v1/enums/notification-priority

Interactive Demo

📋 Description: Retrieves a list of notification priority levels available within the system, enabling users to understand and categorize notifications effectively.

Responses

Status	Meaning	Description	Schema
200	OK	OK	Inline

Example Responses

[
  "HIGH"
]

Response Schema

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

Enums - Find All

HTTP Request

GET /api/v1/enums

Interactive Demo

📋 Description: Retrieves a list of available enumeration values that can be utilized across various business processes, ensuring consistency and standardization in data representation.

Parameters

Name	In	Type	Required	Description
pageable	query	Pageable	true	Indicates whether the response should be paginated, allowing users to retrieve data in manageable segments for improved performance and usability.

Responses

Status	Meaning	Description	Schema
200	OK	OK	PageNotificationDto

Example Responses

{
  "totalElements": 0,
  "totalPages": 0,
  "pageable": {
    "paged": true,
    "unpaged": true,
    "pageNumber": 0,
    "pageSize": 0,
    "offset": 0,
    "sort": {
      "unsorted": true,
      "sorted": true,
      "empty": true
    }
  },
  "numberOfElements": 0,
  "size": 0,
  "content": [
    {
      "id": 0,
      "subscribeMessage": {
        "id": 0,
        "targetId": "string",
        "targetType": "string",
        "topicApplication": "NFS",
        "topicName": "string",
        "topicPriority": "HIGH",
        "topicEnCaption": "string",
        "topicFrCaption": "string",
        "username": "string",
        "action": "SUBSCRIBE",
        "captionKey": "string",
        "en_message": "string",
        "fr_message": "string",
        "url": "string",
        "parameters": [
          {
            "name": "string",
            "dataType": "NUMBER",
            "value": "string"
          }
        ],
        "onlyAfterNow": true,
        "startTime": "2019-08-24T14:15:22Z",
        "cronExpression": "string",
        "endTime": "2019-08-24T14:15:22Z",
        "content": "string"
      },
      "unsubscribeMessage": {
        "id": 0,
        "targetId": "string",
        "targetType": "string",
        "topicApplication": "NFS",
        "topicName": "string",
        "topicPriority": "HIGH",
        "topicEnCaption": "string",
        "topicFrCaption": "string",
        "username": "string",
        "action": "SUBSCRIBE"
      },
      "scheduledTime": "2019-08-24T14:15:22Z",
      "user": {
        "id": 0,
        "accountId": 0,
        "fullName": "string",
        "firstName": "string",
        "lastName": "string",
        "username": "string",
        "email": "string",
        "accountName": "string",
        "profile": "string"
      },
      "state": "ACTIVE",
      "status": "UNREAD"
    }
  ],
  "number": 0,
  "sort": {
    "unsorted": true,
    "sorted": true,
    "empty": true
  },
  "first": true,
  "last": true,
  "empty": true
}

🔐 Authentication: To perform this operation, you must be authenticated by means of one of the following methods: API key

---