POST Agents/List/GetProjectTypeEntity

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/List/GetProjectTypeEntity

Gets a ProjectTypeEntity object.

NsApiSlow threshold: 5000 ms.

Query String Parameters

Parameter Name Type Description
projectTypeEntityId int32 Required The identifier of the ProjectTypeEntity object
$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. 
POST /api/v1/Agents/List/GetProjectTypeEntity?projectTypeEntityId=26
POST /api/v1/Agents/List/GetProjectTypeEntity?$select=name,department,category/id

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: ProjectTypeEntity

Property Name Type Description
ProjTypeId int32 Primary key
Name string The list item
Tooltip string Tooltip or other description
Rank int32 Rank order
DurationUnit string Units for the duration
ProjectDuration int32 Expected duration of project, in given units
Deleted bool 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists
HasGuide bool Does this project type have a guide attached
IsAutoAdvance bool Does the project status advance automatically, when the last guided activity in a status is completed?
Stages array Stages (project statuses), those associated with this ProjType are selected.
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/List/GetProjectTypeEntity
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "ProjTypeId": 350,
  "Name": "Morissette Inc and Sons",
  "Tooltip": "qui",
  "Rank": 995,
  "DurationUnit": "Century",
  "ProjectDuration": 390,
  "Deleted": false,
  "HasGuide": false,
  "IsAutoAdvance": true,
  "Stages": [
    {
      "Id": 786,
      "Name": "Reilly Inc and Sons",
      "ToolTip": "Quia beatae harum dolor in.",
      "Deleted": true,
      "Rank": 671,
      "Type": "sed",
      "ColorBlock": 343,
      "IconHint": "excepturi",
      "Selected": false,
      "LastChanged": "1999-10-22T02:30:47.3975807+02:00",
      "ChildItems": [
        {},
        {}
      ],
      "ExtraInfo": "illo",
      "StyleHint": "neque",
      "Hidden": false,
      "FullName": "Noah Johnston MD",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 146
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 761
    }
  }
}