POST Agents/Archive/CreateDefaultArchiveListResult

• 2 minutes to read
 • 2 minutes to read 
POST /api/v1/Agents/Archive/CreateDefaultArchiveListResult

Loading default values into a new ArchiveListResult.

NsApiSlow threshold: 5000 ms.

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

Property Name Type Description
RowCount int32 Count of rows, independent of paging. If you order up page 1 with page size 50, the row count may still be 279, that being the number of rows that would have been returned in a paging-off situation
Rows array The actual rows, according to the paging info, of the result. See RowCount for a paging-independent count estimate
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/Archive/CreateDefaultArchiveListResult
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

{
  "RowCount": 108,
  "Rows": [
    {
      "EntityName": "project",
      "PrimaryKey": 127,
      "ColumnData": {
        "name": {
          "DisplayValue": "Digital Transformation Initiative 2025",
          "TooltipHint": "Major project for company-wide digital upgrade",
          "LinkHint": "project.main?project_id=127"
        }
      },
      "LinkHint": "view-project",
      "StyleHint": "active-project",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 685
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 701
    }
  }
}