Issues

post

https://app.financekey.com/OData/Issues

An issue is an item used to plan, discuss and track progress for work related tasks.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

issueId

int32

The IssueId field in the Issue table is an identity field that stores a unique numerical value for each issue entry. This field is of the data type integer and is automatically incremented by the system for each new issue added to the table. The IssueId serves as the primary key for the Issue table and is essential in identifying and distinguishing each issue from the others. It allows for easy referencing and organization of data within the table. The IssueId field is an integral part of the efficient management and tracking of issues in the database.

scmKey

int64

The ScmKey field in the Issue table is a bigint data type, which is typically used to store very large integer numbers. This field is commonly associated with source code management (SCM) systems, which are used to track changes made to software code throughout the development process. In this context, the ScmKey may be used to uniquely identify a specific version or revision of a code base. This field can be used for referencing, tracking and organizing code changes within the Issue table, making it a valuable tool for developers and project managers alike.

title

string

required

length between 1 and 256

Title of the Issue.

body

string | null

The Body field in the Issue table is a data type of nvarchar, which is used to store textual data. This field is typically used to provide a detailed description of an issue or problem. It allows for a maximum of around 4,000 characters, making it suitable for longer explanations. This field can also be used to provide additional information or context related to the issue. It is an essential component in effectively documenting and managing the identified issues in this table.

issueTypeId

string

required

length between 1 and 450

The nature of the issue. As well as categorising the issue, the issue type also determines if the issue can be edited or not. Issues which are automatically generated can not be edited. For example 'Release' issues.

effortEstimate

double

required

The estimated effort required to complete the issue in days. Please keep the amount in multiples of 0.5.

assignedToId

int32 | null

The person the issue is assigned to.

synchronisedOn

date-time | null

viewSequence

int32

The ViewSequence field in the Issue table is an integer data type that serves as a unique identifier for each issue's viewing sequence. This field is used to arrange the order in which issues are displayed to users, allowing for a structured and organized viewing experience. The ViewSequence can be adjusted to change the order of issues, making it a valuable tool for managing and prioritizing issues.

leadProjectId

string | null

The LeadProjectId field in the Issue table is a nvarchar data type with a maximum length of 32 characters. This field is used to store the ID of the project lead for a specific issue. It serves as a reference to the individual responsible for managing and resolving the issue. The LeadProjectId is an essential piece of information that helps track the progress of the issue and assign it to the appropriate project lead. With a maximum length of 32, this field can accommodate a wide range of project lead IDs, ensuring efficient management of issues within the table.

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!