GET Project/default
Some tooltip text!
• 7 minutes to read
• 7 minutes to read
GET /api/v1/Project/default
Set default values into a new ProjectEntity.
NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Project agent service CreateDefaultProjectEntity.
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:
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: ProjectEntity
| 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. |
Sample request
GET /api/v1/Project/default
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
Last-Modified: Thu, 30 Mar 2000 16:32:47 G3T
{
"ProjectId": 240,
"Name": "Bechtelar Group",
"ProjectNumber": "768561",
"ProjectMembers": [
{
"ProjectmemberId": 205,
"ContactId": 780,
"ProjectId": 990,
"ContactName": "Schmitt, Block and Olson",
"ContactDepartment": "",
"ProjectName": "Rosenbaum-Rowe",
"EmailId": 530,
"EmailAddress": "antone.mccullough@hilpertbeer.uk",
"CountryId": 359,
"Firstname": "Zander",
"MiddleName": "Farrell, Schowalter and Greenfelder",
"Lastname": "Bartell",
"PersonId": 533,
"Mrmrs": "nam",
"ProjectMemberTypeName": "Sporer Inc and Sons",
"Phone": "639-747-0210",
"PhoneId": 709,
"ProjectMemberTypeId": 756,
"EmailAddressName": "julian@okeefe.us",
"Comment": "ipsam",
"FullName": "May Miller",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 529
}
}
}
],
"Urls": [
{
"Value": "sed",
"StrippedValue": "soluta",
"Description": "Self-enabling global conglomeration",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 595
}
}
},
{
"Value": "sed",
"StrippedValue": "soluta",
"Description": "Self-enabling global conglomeration",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 595
}
}
}
],
"CreatedDate": "2021-01-03T16:32:47.6964194+01:00",
"UpdatedDate": "2000-03-30T16:32:47.6964194+02:00",
"Description": "User-centric heuristic matrix",
"Postit": "id",
"CreatedBy": null,
"UpdatedBy": null,
"Associate": null,
"ProjectStatus": null,
"ProjectType": null,
"HasImage": false,
"ImageDescription": "Quality-focused executive time-frame",
"ActiveStatusMonitorId": 635,
"Links": [
{
"EntityName": "Stroman-Vandervort",
"Id": 469,
"Description": "Switchable incremental contingency",
"ExtraInfo": "et",
"LinkId": 620,
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 568
}
}
}
],
"ActiveLinks": 366,
"Completed": false,
"NextMilestoneDate": "2016-11-23T16:32:47.6964194+01:00",
"NmdAppointmentId": 353,
"EndDate": "2013-07-20T16:32:47.6964194+02:00",
"ActiveErpLinks": 865,
"UserDefinedFields": {
"SuperOffice:1": "False",
"SuperOffice:2": "Whitney Hyatt"
},
"ExtraFields": {
"ExtraFields1": "neque",
"ExtraFields2": "molestiae"
},
"CustomFields": {
"CustomFields1": "fugit",
"CustomFields2": "eos"
},
"PublishEventDate": "2023-11-08T16:32:47.6964194+01:00",
"PublishTo": "2014-02-16T16:32:47.6964194+01:00",
"PublishFrom": "2021-03-02T16:32:47.6964194+01:00",
"IsPublished": true,
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 768
}
}
}