Projects

patch

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

A log of all FinanceKey projects.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

projectId

string

required

length between 1 and 32

The ProjectId field in the Project table is a unique identifier for each project record. It is of data type nvarchar with a maximum length of 32 characters, allowing for a wide range of potential project codes or names. This primary key field ensures that each project in the table is uniquely identifiable and helps with efficient data retrieval and organization.

description

string

required

length between 1 and 256

The Description field in the Project table is of data type nvarchar, allowing for the storage of textual data. It has a maximum length of 256 characters, providing ample space for detailed descriptions of various projects. This field can be used to provide a brief overview or summary of the project, its purpose, and any relevant details. Data entered in this field can be used for organizing and categorizing projects, making it easier to search and filter through large amounts of data. The nvarchar data type ensures that the field can accommodate a wide range of characters, including special symbols and non-English characters, making it versatile for international projects.

comment

string | null

Miscellaneous notes and information for the entry or record.

repositoryId

string | null

projectPhaseId

string | null

The ProjectPhaseId field in the Project table is a data column that stores the unique identifying number for each phase of a project. It is of the nvarchar data type, which allows for a combination of both numeric and alphanumeric characters to be stored. The maximum length of this field is 450, providing ample space for detailed phase identifiers. This field is important for organizing and tracking the progress of a project, as well as for referencing specific phases in project management software tools. The ProjectPhaseId field supports efficient project management by providing a clear and concise way to differentiate between different project phases within the project table.

end

date-time

required

The 'End' field of data type datetime2 in the 'Project' table contains information about the date and time that a project will be completed or concluded. This field can be used to track and manage project timelines, deadlines, and end dates. The datetime2 data type allows for a high level of precision in recording specific dates and times, making it useful for accurately tracking project progress and completion dates. By storing the end date in this field, it allows for easy comparison and analysis of project durations and timelines. Additionally, the datetime2 data type can also store time zone information, ensuring accuracy and consistency across different time zones. Overall, the 'End' field of data type datetime2 in the 'Project' table is essential for effectively managing project timelines and deadlines.

projectLeadId

int32 | null

start

date-time

required

The Start field in the Project table is a data type of datetime2, which represents a specific date and time in a project's timeline. This datetime2 data type allows for greater precision and flexibility in recording the start date and time of a project, compared to other date and time data types. It is commonly used to track the beginning of a project, whether it is a one-time event or an ongoing endeavor. This field is essential for accurately organizing and managing project timelines.

projectTypeId

string | null

The ProjectTypeId field in the Project table is an nvarchar data type designed to store unique identifiers for different types of projects. This field can accommodate text strings with a maximum length of 450 characters, allowing it to support a wide variety of project classifications. It is essential for categorizing projects, enabling efficient reporting and management by linking each project to its corresponding type.

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!