POST Agents/Project/GetProjectList

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Project/GetProjectList

Gets an array of Project objects.

NsApiSlow threshold: 2000 ms.

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. 
POST /api/v1/Agents/Project/GetProjectList?$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
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
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.

Request Body: projectIds

The identifiers of the Project object

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
ProjectId int32 Primary key
Name string Project name
Description string The projects description
URL string URL address
Type string The project type.
AssociateId int32 The project owner id (associate id)
AssociateFullName string The project owner
TypeId int32
Updated date-time Last updated date in UTC.
StatusId int32 The projects status id
Status string The projects status
TextId int32 The id of the description
PublishTo date-time Publication valid to (inclusive)
PublishFrom date-time Publication valid from (inclusive)
IsPublished bool
URLName string Visible field
ProjectNumber string Automatically generated number
ActiveErpLinks int32 The number of active erp links
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/Project/GetProjectList
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

[
  {
    "ProjectId": 517,
    "Name": "Website Redesign 2024",
    "Description": "Complete redesign and modernization of company website",
    "URL": "https://redesign.acmecorp.com/",
    "Type": "Internal Project",
    "AssociateId": 873,
    "AssociateFullName": "David Martinez",
    "TypeId": 459,
    "Updated": "2024-11-20T10:30:00+01:00",
    "StatusId": 232,
    "Status": "Planning",
    "TextId": 312,
    "PublishTo": "2025-03-31T23:59:00+01:00",
    "PublishFrom": "2024-10-01T00:00:00+02:00",
    "IsPublished": true,
    "URLName": "https://redesign.acmecorp.com/",
    "ProjectNumber": "P-2024-003",
    "ActiveErpLinks": 79,
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.String",
        "FieldLength": 456
      }
    }
  }
]