Post userspublishedviews

This operation searches the Forum specific by SYSID for the Users which are identified by the provided search criteria.

This operation requires a User Publisher Request argument with the following fields:

This operation returns a UserViewWrapper

POST /users/published/views

Error

A valid request URL is required to generate request examples

201

{
  "views": [
    {
      "privateProfile": true,
      "lastName": "...",
      "city": "...",
      "postalCode": "...",
      "middleInitial": "...",
      "country": "...",
      "roleName": "...",
      "address1": "...",
      "mobilePhone": "...",
      "sysidUser": 12345,
      "stateProvince": "...",
      "department": "...",
      "workPhone": "...",
      "sysidStatus": 12345,
      "images": [
        {
          "sysidUserImage": 12345,
          "defaultImage": true,
          "thumbnailSource": "...",
          "width": 12345,
          "displayOrder": 12345,
          "height": 12345,
          "description": "...",
          "imageSource": "...",
          "name": "...",
          "sysidApplicationUser": 12345
        },
        {
          "sysidUserImage": 12345,
          "defaultImage": true,
          "thumbnailSource": "...",
          "width": 12345,
          "displayOrder": 12345,
          "height": 12345,
          "description": "...",
          "imageSource": "...",
          "name": "...",
          "sysidApplicationUser": 12345
        }
      ],
      "sysidHomeLocation": 12345,
      "sysidLanguage": 12345,
      "emailAddress": "...",
      "firstName": "...",
      "originalUser": true,
      "locationName": "...",
      "address2": "...",
      "accountLocked": true,
      "statusMessage": "...",
      "title": "..."
    },
    {
      "privateProfile": true,
      "lastName": "...",
      "city": "...",
      "postalCode": "...",
      "middleInitial": "...",
      "country": "...",
      "roleName": "...",
      "address1": "...",
      "mobilePhone": "...",
      "sysidUser": 12345,
      "stateProvince": "...",
      "department": "...",
      "workPhone": "...",
      "sysidStatus": 12345,
      "images": [
        {
          "sysidUserImage": 12345,
          "defaultImage": true,
          "thumbnailSource": "...",
          "width": 12345,
          "displayOrder": 12345,
          "height": 12345,
          "description": "...",
          "imageSource": "...",
          "name": "...",
          "sysidApplicationUser": 12345
        },
        {
          "sysidUserImage": 12345,
          "defaultImage": true,
          "thumbnailSource": "...",
          "width": 12345,
          "displayOrder": 12345,
          "height": 12345,
          "description": "...",
          "imageSource": "...",
          "name": "...",
          "sysidApplicationUser": 12345
        }
      ],
      "sysidHomeLocation": 12345,
      "sysidLanguage": 12345,
      "emailAddress": "...",
      "firstName": "...",
      "originalUser": true,
      "locationName": "...",
      "address2": "...",
      "accountLocked": true,
      "statusMessage": "...",
      "title": "..."
    }
  ],
  "nextStartRow": 12345,
  "hasAdditional": true
}

Body

application/json

criteria · UserViewCriteria · object

Show child attributes

Example:

{
  "startRow": 12345,
  "maxRows": 12345,
  "homeLocationName": "...",
  "matchAnyCustomAttribute": true,
  "sortAscending": true,
  "sysidDepartments": [12345, 12345],
  "includeLockedUser": true,
  "sysidStatuses": [12345, 12345],
  "sysidRoles": [12345, 12345],
  "emailAddress": "...",
  "sysidUserGroups": [12345, 12345],
  "lastName": "...",
  "sysidSwitchDevices": [12345, 12345],
  "forManagement": true,
  "sysidApplicationUsers": [12345, 12345],
  "customAttribs": [
    {
      "stringValue": "...",
      "searchType": "EQUAL",
      "sysidDataType": 12345,
      "dateTimeValue": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAttribute": 12345,
      "numberValue": 12345,
      "booleanValue": true
    },
    {
      "stringValue": "...",
      "searchType": "EQUAL",
      "sysidDataType": 12345,
      "dateTimeValue": {
        "discriminator": "AqDate",
        "hour": 12345,
        "tzIdValue": "...",
        "year": 12345,
        "month": 12345,
        "dayOfMonth": 12345,
        "minute": 12345,
        "noEndDate": true
      },
      "sysidAttribute": 12345,
      "numberValue": 12345,
      "booleanValue": true
    }
  ],
  "sysidTitles": [12345, 12345],
  "sysidHomeLocations": [12345, 12345],
  "sysidBusinessUnits": [12345, 12345],
  "exactMatch": true,
  "sortColumn": "EMAIL",
  "accountOnly": true,
  "firstName": "...",
  "sysidManagers": [12345, 12345]
}

sysidForum · integer<int32>

Response

201 - application/json

UserViewWrapper

nextStartRow · integer<int32> · required

hasAdditional · boolean · required

views · UserView · object[]

Show child attributes