POST Agents/Import/PreviewImport

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Import/PreviewImport

Preview the import

NsApiSlow threshold: 5000 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/Import/PreviewImport?$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: request

ImportLines, ColumnDefinition, Culture, Context

Property Name Type Description
ImportLines Array
ColumnDefinition Array
Culture String
Context String

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
Values array An array of the values that will be imported on the entity
Selected bool True if the entity shall be imported, false if the entity shall be ignored
Operation string Which operation will be used? This is a read-only property
Type string Which entity type will be created? This is a read-only property
ExternalKey string Optional external primary key for the row
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/Import/PreviewImport
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "ImportLines": [
    {
      "Values": [
        "placeat",
        "inventore"
      ],
      "Selected": false,
      "Operation": "ContactAdded",
      "Type": "Contact",
      "ExternalKey": "nobis"
    },
    {
      "Values": [
        "placeat",
        "inventore"
      ],
      "Selected": false,
      "Operation": "ContactAdded",
      "Type": "Contact",
      "ExternalKey": "nobis"
    }
  ],
  "ColumnDefinition": [
    "quis",
    "perferendis"
  ],
  "Culture": "inventore",
  "Context": "excepturi"
}

Sample response

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

[
  {
    "Values": [
      "Sarah Johnson",
      "sarah.johnson@techcorp.com",
      "Tech Corporation",
      "+1 555-0456",
      "Sales Manager"
    ],
    "Selected": true,
    "Operation": "ContactAdded",
    "Type": "Contact",
    "ExternalKey": "IMPORT-002",
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 871
      }
    }
  }
]