POST Selection

• 13 minutes to read
 • 13 minutes to read 
POST /api/v1/Selection

Creates a new SelectionEntity

Calls the Selection agent service SaveSelectionEntity. 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/Selection?$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: newEntity

The SelectionEntity to be saved.

Property Name Type Description
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
Associate Associate Owner of the selection
CreatedBy Associate Who created the selection
UpdatedBy Associate Who last modified the selection
SelectionCategory SelectionCategory Selection category type (list item) Use MDO List name "searchCat" to get list items.
GroupIdx Integer Original primary user group of associate
IncludePerson Integer 0 = Include first person, 1 = Include all persons, 2 = Include no persons
MemberCount Integer How many selectionmembers (for progress bar calculations) - estimate, -1 (or 4294967295) means we don't know
Name String Name of selection, freetext indexed
PostitTextId Integer Postit text record id.
CreatedDate String Registered when in UTC.
SelectionId Integer Primary key
SoundEx String What the name sounds like, for duplicate detection
Source Integer How did we get this selection? For future integration needs
TextId Integer Description text record id
UpdatedDate String Last updated when in UTC.
UpdatedCount Integer Number of updates made to this record
Visibility Integer Obsolete, but still maintained denormalization of visiblefor
SelectionType String Static/Dynamic/Combined?
CompanyUnique Boolean Filter out duplicate members based on company?
TargetTableNumber Integer TargetTableNumber defines the type of selection members this selection contains. e.g. the table number for 'contact', or 'project' or 'sale'
TargetTableName String TargetTableName contains the name of the table in lowercase. defines the type of selection members this selection contains. e.g. 'contact', or 'project' or 'sale'
Completed Boolean The Completed state.
LeftSelectionId Integer LeftSelectionId is used in combination with RightSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
RightSelectionId Integer RightSelectionId is used in combination with LeftSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
SelectionUnionType String How to combine the two selections when SelectionType = Combined.
MainProviderName String The name of the Archive Provider that will deliver the content of the archive - the actual entity rows
ShadowProviderName String The name, if relevant, of the Archive Provider that will deliver the Shadow rows: contact/person rows related to the actual entity. Can be blank, indicating that there is no shadow archive
ChartKey String ID/key of the last-used chart tile on this selection
LastLoaded String The date/time this selection was last loaded (selectionentity fetched)
LastLoadedBy Integer Who last loaded this selection
LastLoadedByAssociate Associate Associate that last looked at the selection members; only date (not time) is valid
LastMembershipChange String The date/time the membership the selection last changed. Dynamic: change of criteria; Static: add/remove members; Combined: change of algorithm
LastMembershipChangeBy Integer Who last changed the membership
LastMembershipChangeByAssociate Associate Associate that last changed the selection membership (static members, dynamic criteria, combined parameters); only date (not time) is valid
MainHeading String 'Static selection of Companies', or whatever else is appropriate, made by combining text resources for the type and the entity (plural form); this string will contain resource references
MemberTabHeading String 'Companies', or whatever else is appropriate - the plural form of the entity name; this string will contain resource references
MailingsProviderName String The name of the provider for the Mailings tab, if relevant; this string will contain resource references
DashboardTileDefinitionId Integer The associated tile definition
VisibleFor Array The set of users or groups the record is visible for

Response:

OK

Response Description
200 OK

Response body: SelectionEntityWithLinks

Property Name Type Description
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
Associate Associate Owner of the selection
CreatedBy Associate Who created the selection
UpdatedBy Associate Who last modified the selection
SelectionCategory SelectionCategory Selection category type (list item) Use MDO List name "searchCat" to get list items.
GroupIdx int32 Original primary user group of associate
IncludePerson int32 0 = Include first person, 1 = Include all persons, 2 = Include no persons
MemberCount int64 How many selectionmembers (for progress bar calculations) - estimate, -1 (or 4294967295) means we don't know
Name string Name of selection, freetext indexed
PostitTextId int32 Postit text record id.
CreatedDate date-time Registered when in UTC.
SelectionId int32 Primary key
SoundEx string What the name sounds like, for duplicate detection
Source int32 How did we get this selection? For future integration needs
TextId int32 Description text record id
UpdatedDate date-time Last updated when in UTC.
UpdatedCount int32 Number of updates made to this record
Visibility int32 Obsolete, but still maintained denormalization of visiblefor
SelectionType string Static/Dynamic/Combined?
CompanyUnique bool Filter out duplicate members based on company?
TargetTableNumber int32 TargetTableNumber defines the type of selection members this selection contains. e.g. the table number for 'contact', or 'project' or 'sale'
TargetTableName string TargetTableName contains the name of the table in lowercase. defines the type of selection members this selection contains. e.g. 'contact', or 'project' or 'sale'
Completed bool The Completed state.
LeftSelectionId int32 LeftSelectionId is used in combination with RightSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
RightSelectionId int32 RightSelectionId is used in combination with LeftSelectionId and CombinationType to define an union of two selections when SelectionType=Combined.
SelectionUnionType string How to combine the two selections when SelectionType = Combined.
MainProviderName string The name of the Archive Provider that will deliver the content of the archive - the actual entity rows
ShadowProviderName string The name, if relevant, of the Archive Provider that will deliver the Shadow rows: contact/person rows related to the actual entity. Can be blank, indicating that there is no shadow archive
ChartKey string ID/key of the last-used chart tile on this selection
LastLoaded date-time The date/time this selection was last loaded (selectionentity fetched)
LastLoadedBy int32 Who last loaded this selection
LastLoadedByAssociate Associate Associate that last looked at the selection members; only date (not time) is valid
LastMembershipChange date-time The date/time the membership the selection last changed. Dynamic: change of criteria; Static: add/remove members; Combined: change of algorithm
LastMembershipChangeBy int32 Who last changed the membership
LastMembershipChangeByAssociate Associate Associate that last changed the selection membership (static members, dynamic criteria, combined parameters); only date (not time) is valid
MainHeading string 'Static selection of Companies', or whatever else is appropriate, made by combining text resources for the type and the entity (plural form); this string will contain resource references
MemberTabHeading string 'Companies', or whatever else is appropriate - the plural form of the entity name; this string will contain resource references
MailingsProviderName string The name of the provider for the Mailings tab, if relevant; this string will contain resource references
DashboardTileDefinitionId int32 The associated tile definition
VisibleFor array The set of users or groups the record is visible for
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.
_Links object

Sample request

POST /api/v1/Selection
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "Description": "Organized object-oriented encoding",
  "Postit": "qui",
  "Associate": null,
  "CreatedBy": null,
  "UpdatedBy": null,
  "SelectionCategory": null,
  "GroupIdx": 861,
  "IncludePerson": 636,
  "MemberCount": 99.99,
  "Name": "Jacobs, VonRueden and Harber",
  "PostitTextId": 377,
  "CreatedDate": "2008-10-18T14:34:02.3782736+02:00",
  "SelectionId": 549,
  "SoundEx": "id",
  "Source": 710,
  "TextId": 780,
  "UpdatedDate": "2019-05-31T14:34:02.3782736+02:00",
  "UpdatedCount": 888,
  "Visibility": 777,
  "SelectionType": "Combined",
  "CompanyUnique": false,
  "TargetTableNumber": 856,
  "TargetTableName": "Sipes Group",
  "Completed": false,
  "LeftSelectionId": 436,
  "RightSelectionId": 908,
  "SelectionUnionType": "Intersect",
  "MainProviderName": "Stark-Bradtke",
  "ShadowProviderName": "Stamm Inc and Sons",
  "ChartKey": "odio",
  "LastLoaded": "2006-12-03T14:34:02.3782736+01:00",
  "LastLoadedBy": 839,
  "LastLoadedByAssociate": null,
  "LastMembershipChange": "2021-01-05T14:34:02.3782736+01:00",
  "LastMembershipChangeBy": 885,
  "LastMembershipChangeByAssociate": null,
  "MainHeading": "perferendis",
  "MemberTabHeading": "amet",
  "MailingsProviderName": "Rogahn, Crooks and Stamm",
  "DashboardTileDefinitionId": 699,
  "VisibleFor": [
    {
      "VisibleId": 233,
      "Visibility": "All",
      "DisplayValue": "rem"
    },
    {
      "VisibleId": 233,
      "Visibility": "All",
      "DisplayValue": "rem"
    }
  ]
}

Sample response

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

{
  "Description": "Selection of contacts",
  "Postit": "enim",
  "Associate": null,
  "CreatedBy": null,
  "UpdatedBy": null,
  "SelectionCategory": null,
  "GroupIdx": 105,
  "IncludePerson": 664,
  "MemberCount": 99.99,
  "Name": "VIP Customers",
  "PostitTextId": 462,
  "CreatedDate": "2000-05-31T14:34:02.3782736+02:00",
  "SelectionId": 701,
  "SoundEx": "adipisci",
  "Source": 441,
  "TextId": 682,
  "UpdatedDate": "2013-10-18T14:34:02.3782736+02:00",
  "UpdatedCount": 686,
  "Visibility": 933,
  "SelectionType": "Combined",
  "CompanyUnique": true,
  "TargetTableNumber": 429,
  "TargetTableName": "Green, Jenkins and Jones",
  "Completed": false,
  "LeftSelectionId": 861,
  "RightSelectionId": 200,
  "SelectionUnionType": "Intersect",
  "MainProviderName": "Mohr, Bechtelar and Miller",
  "ShadowProviderName": "Anderson-Kutch",
  "ChartKey": "qui",
  "LastLoaded": "2007-12-24T14:34:02.3782736+01:00",
  "LastLoadedBy": 977,
  "LastLoadedByAssociate": null,
  "LastMembershipChange": "2012-05-04T14:34:02.3782736+02:00",
  "LastMembershipChangeBy": 204,
  "LastMembershipChangeByAssociate": null,
  "MainHeading": "laudantium",
  "MemberTabHeading": "officia",
  "MailingsProviderName": "Hermann LLC",
  "DashboardTileDefinitionId": 56,
  "VisibleFor": [
    {
      "VisibleId": 560,
      "Visibility": "All",
      "DisplayValue": "voluptatem",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 708
        }
      }
    },
    {
      "VisibleId": 560,
      "Visibility": "All",
      "DisplayValue": "voluptatem",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 708
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 491
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/contact/321",
    "Archive": "https://www.example.com/api/v1/contact"
  }
}