POST Agents/Targets/GetTargetDimensionsForEntityType

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Targets/GetTargetDimensionsForEntityType

Returns the target dimensions for the given entity type.

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/Targets/GetTargetDimensionsForEntityType?$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

EntityType

Property Name Type Description
EntityType String

Response:array

OK

Response Description
200 OK

Response body: array

Property Name Type Description
TargetDimensionId int32 Primary key
AssignmentLevel string What level this dimension can be assigned to (Company, Group, Associate)
EntityType string Entity type for this set of targets (Sale, Project, Selection, Appointment...)
MeasurementUnit string What to measure (Amount, Count, Profit...
DimensionListField string List that defines the dimensions for this target matrix (ex: Sale type, source, partner, business, udef or extrafield lists...)
DimensionListName string List name (can be used by list provider system to get list items)
DimensionListId int32 List id (can be used by list provider system to get list items)
DimensionListLabel string list label (list column name)
SelectedDimensions array id's of the selected/wanted dimensions (what sale types or udef list lines that should be target dimensions)
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/Targets/GetTargetDimensionsForEntityType
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "EntityType": "None"
}

Sample response

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

[
  {
    "TargetDimensionId": 419,
    "AssignmentLevel": "Associate",
    "EntityType": "None",
    "MeasurementUnit": "Amount",
    "DimensionListField": "ad",
    "DimensionListName": "Cummerata Inc and Sons",
    "DimensionListId": 315,
    "DimensionListLabel": "incidunt",
    "SelectedDimensions": [
      806,
      87
    ],
    "TableRight": null,
    "FieldProperties": {
      "fieldName": {
        "FieldRight": null,
        "FieldType": "System.Int32",
        "FieldLength": 126
      }
    }
  }
]