GET Project/{id}

• 8 minutes to read

GET /api/v1/Project/{id}

Gets a ProjectEntity object.

Calls the Project agent service GetProjectEntity.

Path Part	Type	Description
id	int32	The id of the ProjectEntity to return. Required

Query String Parameters

Parameter Name	Type	Description
$select	string	Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.
fk	bool	Load foreign keys on this entity into the ExtraFields property as 'app.device.keyname'='123' pairs.

GET /api/v1/Project/{id}?$select=name,department,category/id
GET /api/v1/Project/{id}?fk=True

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept	Content-type(s) you would like the response in: `application/json`, `text/json`, `application/xml`, `text/xml`, `application/json-patch+json`, `application/merge-patch+json`
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

ProjectEntity found.

Response	Description
200	ProjectEntity found.
304	ProjectEntity has not changed since the requested If-Modified-Since date.
404	Not Found.

Response body: ProjectEntityWithLinks

Property Name	Type	Description
ProjectId	int32	Primary key
Name	string	Project name
ProjectNumber	string	Automatically generated number
ProjectMembers	array	The persons which are members of the project
Urls	array	The project's internet adresses
CreatedDate	date-time	Registered date in UTC.
UpdatedDate	date-time	Last updated date in UTC.
Description	string	The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases
Postit	string	The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases
CreatedBy	Associate	The person that created the project
UpdatedBy	Associate	The person that last updated the project
Associate	Associate	The person that created the project Use MDO List name "associate" to get list items.
ProjectStatus	ProjectStatus	Project status is a list defined by the database administrator. Different statuses of a project may be: “In planning”, “Started”, “Finished” and so on Use MDO List name "projectstatus" to get list items.
ProjectType	ProjectType	Project type is a list defined by the database admin. for example: 'Large', 'Small', 'Party'... Use MDO List name "projecttype" to get list items.
HasImage	bool	True if the project has an image. (This is the image that is displayed in the CRM client)
ImageDescription	string	Description of the project image if it exists. (This is the image that is displayed in the CRM client)
ActiveStatusMonitorId	int32	Active status monitor identity with the lowest rank for project
Links	array	List of all elements linked to the project
ActiveLinks	int32	Number of active links to documents, other appointments, and such
Completed	bool	Done (0=false, 1=true). Status implies changes in which fields are shown in GUI, as well as which fields can be updated
NextMilestoneDate	date-time	Calculated date, reflects date of closest non-complete future milestone activity
NmdAppointmentId	int32	ID of appointment that "caused" the nextMilestoneDate, can be 0
EndDate	date-time	Planned end date for project, inhertied from type and later editable
ActiveErpLinks	int32	The number of active erp links
UserDefinedFields	object	Deprecated: Use {SuperOffice.CRM.Services.ProjectEntity.CustomFields} instead. Dictionary of user defined field data. The key string is the ProgId of the UdefField, or if the ProgId is empty it is a string of the format "SuperOffice:[UdefFieldIdentity]", e.g. "SuperOffice:1234"
ExtraFields	object	Deprecated: Use {SuperOffice.CRM.Services.ProjectEntity.CustomFields} instead. Extra fields added to the carrier. This could be data from Plug-ins, the foreign key system, external applications, etc.
CustomFields	object	Udef + Extra fields added to the carrier. Extra fields as defined by changes to database schema + user-defined fields as defined by admin. Custom fields combines user defined fields and extra fields into one bucket. The individual {SuperOffice.CRM.Services.ProjectEntity.ExtraFields} and UserDefinedFields properties are deprecated in favor of this combined collection.
PublishEventDate	date-time	Publish event date
PublishTo	date-time	Publication valid to (inclusive)
PublishFrom	date-time	Publication valid from (inclusive)
IsPublished	bool	Publication is published
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.
_Links	object

Sample request

GET /api/v1/Project/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 ProjectEntity found.
Content-Type: application/json; charset=utf-8
Last-Modified: Wed, 15 Oct 2008 16:32:47 G10T

{
  "ProjectId": 153,
  "Name": "McKenzie-Mraz",
  "ProjectNumber": "1438274",
  "ProjectMembers": [
    {
      "ProjectmemberId": 314,
      "ContactId": 624,
      "ProjectId": 730,
      "ContactName": "Murazik, Brakus and Quigley",
      "ContactDepartment": "",
      "ProjectName": "Beatty-Considine",
      "EmailId": 356,
      "EmailAddress": "lonie@thompson.co.uk",
      "CountryId": 277,
      "Firstname": "Brandi",
      "MiddleName": "Sporer, Schuster and Schneider",
      "Lastname": "Ferry",
      "PersonId": 118,
      "Mrmrs": "ratione",
      "ProjectMemberTypeName": "Feeney Group",
      "Phone": "(208)561-1752 x0992",
      "PhoneId": 736,
      "ProjectMemberTypeId": 586,
      "EmailAddressName": "stephany_zieme@crist.uk",
      "Comment": "error",
      "FullName": "Cassidy Valerie Yundt Jr.",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 263
        }
      }
    }
  ],
  "Urls": [
    {
      "Value": "asperiores",
      "StrippedValue": "distinctio",
      "Description": "Self-enabling uniform capability",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 152
        }
      }
    },
    {
      "Value": "asperiores",
      "StrippedValue": "distinctio",
      "Description": "Self-enabling uniform capability",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 152
        }
      }
    }
  ],
  "CreatedDate": "2011-07-25T16:32:47.7120406+02:00",
  "UpdatedDate": "2008-10-15T16:32:47.7120406+02:00",
  "Description": "Synchronised empowering knowledge base",
  "Postit": "sapiente",
  "CreatedBy": null,
  "UpdatedBy": null,
  "Associate": null,
  "ProjectStatus": null,
  "ProjectType": null,
  "HasImage": false,
  "ImageDescription": "Right-sized background contingency",
  "ActiveStatusMonitorId": 478,
  "Links": [
    {
      "EntityName": "Prosacco-Jaskolski",
      "Id": 459,
      "Description": "Realigned eco-centric project",
      "ExtraInfo": "dolorum",
      "LinkId": 524,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 181
        }
      }
    }
  ],
  "ActiveLinks": 187,
  "Completed": false,
  "NextMilestoneDate": "1998-03-06T16:32:47.7120406+01:00",
  "NmdAppointmentId": 452,
  "EndDate": "1999-06-23T16:32:47.7120406+02:00",
  "ActiveErpLinks": 438,
  "UserDefinedFields": {
    "SuperOffice:1": "1862026316",
    "SuperOffice:2": "Denis McGlynn"
  },
  "ExtraFields": {
    "ExtraFields1": "deserunt",
    "ExtraFields2": "eum"
  },
  "CustomFields": {
    "CustomFields1": "unde",
    "CustomFields2": "suscipit"
  },
  "PublishEventDate": "2024-04-07T16:32:47.7120406+02:00",
  "PublishTo": "2015-02-16T16:32:47.7120406+01:00",
  "PublishFrom": "2017-08-18T16:32:47.7120406+02:00",
  "IsPublished": true,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 939
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}