Activities

patch

https://app.financekey.com/OData/Activities({key})

Defines an activity or state of significance that can take place on an entity.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

activityId

string

required

length between 1 and 32

The ActivityId field is a primary key in the Activity table, designed to uniquely identify each activity record. It has a data type of nvarchar with a maximum length of 32 characters, allowing for the storage of alphanumeric identifiers. This ensures that each activity can be distinctly referenced and efficiently retrieved within the database. The use of nvarchar accommodates a wide range of character sets, providing flexibility for internationalization and special characters.

name

string | null

The 'Name' field in the 'Activity' table is of the data type nvarchar with a maximum length of 32 characters. This field is designed to store textual identifiers for activities, allowing for the inclusion of Unicode characters to support a wide range of languages and symbols.

description

string

required

length between 1 and 128

A brief textual overview of the activity, allowing for up to 128 characters of alphanumeric input, providing context and details about the specific activity recorded in the database.

comment

string | null

Miscellaneous notes and information for the entry or record.

badgeId

string | null

The BadgeId field in the Activity table is an nvarchar data type designed to store a unique identifier for badges, with a maximum length of 32 characters. This field is intended to facilitate tracking and referencing specific badges associated with activities, ensuring efficient data management and retrieval.

badgeCaption

string

required

length between 1 and 32

The BadgeCaption field is an nvarchar data type with a maximum length of 32 characters in the Activity table. This field is designed to store a brief descriptive label or caption for a badge associated with a specific activity, providing a concise identification that enhances user engagement and recognition.

badgeImage

string

required

length between 1 and 256

Stores the Image of the Badge that should be displayed for the Activity.

categoryId

string | null

Description: The CategoryId field in the Activity table is an nvarchar data type, allowing for alphanumeric characters with a maximum length of 450. This field is used to store unique identifiers for different categories associated with each activity entry, enabling efficient grouping and retrieval of related activities based on category classifications.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!