Projects

Queryable, Introduced in version 2.31

GET https://localhost:8001/sv/001.1/api/v1/Common/Projects

Represents a project.

GUID

1A7530E0-9336-488A-9C01-DD6240AC01A7

Required permission

Show projects

Properties

Name Type Summary Introduced in
Id Int64 The business key identifier of the project.
Code String The human readable code of the project.
Description String The translated description of the project.
Status Int32 The status of the project.

  • Registered: 1
  • InProgress: 3
  • Finished: 4
  • Standby: 6
  • History: 9
Priority Int32 The priority of the project.
StartDate DateTimeOffset The start date of the project.
EndDate DateTimeOffset The end date of the project.
CustomerId Int64? The business key identifier of the customer that the project
belongs to.
CustomerOrderId Int64? The business key identifier of the project's customer order.

 Introduced in version 2.36
CustomerOrder CustomerOrders The customer order of the project.

  • Expandable
 Introduced in version 2.36
CustomerOrderNumber String The customer's order number of the project.
 Introduced in version 2.36
SellerId Int64? The business key identifier of the project's seller.

 Introduced in version 2.36
Seller Persons The seller of the project.

  • Expandable
 Introduced in version 2.36
OurReferenceId Int64? The business key identifier of the project's our reference.

 Introduced in version 2.36
OurReference Persons Our reference of the project.

  • Expandable
 Introduced in version 2.36
CustomerReferenceId Int64? The business key identifier of the project's customer reference.

 Introduced in version 2.36
CustomerReference BusinessContactReferences The customer's reference of the project.

  • Expandable
 Introduced in version 2.36
InternalCommentId Int64? The business key identifier of the project's internal comment.

References Comments
 Introduced in version 2.36
InternalComment Comments The internal comment of the project

  • Expandable
 Introduced in version 2.36
ExternalCommentId Int64? The business key identifier of the project's external comment.

 Introduced in version 2.36
ExternalComment Comments The external comment of the project.

  • Expandable
 Introduced in version 2.36
LongDescription String The long description of the project.

  • Max length is 500
 Introduced in version 2.36
ExtraFields ExtraFields[] A collection of extra field values for the project.

  • Expandable
 Introduced in version 2.36
Phases ProjectPhases[] The phases of the project.

  • Expandable
 Introduced in version 2.36
ProjectTypeId Int64 The business key identifier of the project's type.

 Introduced in version 2.43
ProjectType ProjectTypes The project type.

  • Expandable
 Introduced in version 2.43
ProjectGroupId Int64? The business key identifier of the project's group.

 Introduced in version 2.43
ProjectGroup ProjectGroups The project group of the project.

  • Expandable
 Introduced in version 24.6
ProjectCostBudgets ProjectCostBudgets[] The project cost budgets of the project.

  • Expandable
 Introduced in version 2.46
ProjectCostForecasts ProjectCostForecasts[] The project cost forecasts of the project.

  • Expandable
 Introduced in version 2.46
ProjectAggregates ProjectAggregates[] The project aggregates of the project.

  • Expandable
 Introduced in version 2.46
ParentProjectId Int64? The business key identifier of the parent project to the project.

 Introduced in version 22.3
ProjectManagerId Int64? The business key identifier of the manager for the project.

 Introduced in version 23.4

Example

{
  "Id": 0,
  "Code": null,
  "Description": null,
  "Status": 0,
  "Priority": 0,
  "StartDate": "0001-01-01T00:00:00+00:00",
  "EndDate": "0001-01-01T00:00:00+00:00",
  "CustomerId": null,
  "CustomerOrderId": null,
  "CustomerOrder": null,
  "CustomerOrderNumber": null,
  "SellerId": null,
  "Seller": null,
  "OurReferenceId": null,
  "OurReference": null,
  "CustomerReferenceId": null,
  "CustomerReference": null,
  "InternalCommentId": null,
  "InternalComment": null,
  "ExternalCommentId": null,
  "ExternalComment": null,
  "LongDescription": null,
  "ExtraFields": null,
  "Phases": null,
  "ProjectTypeId": 0,
  "ProjectType": null,
  "ProjectGroupId": null,
  "ProjectGroup": null,
  "ProjectCostBudgets": null,
  "ProjectCostForecasts": null,
  "ProjectAggregates": null,
  "ParentProjectId": null,
  "ProjectManagerId": null
}