ThoughtFarmer Public API Documentation API Reference

Public Api

Contact: helpdesk@thoughtfarmer.com
Version: v1

ApiCalendar

GET /api/calendar/{contentId}

contentId: integer (int32)
in path

(no description)

startIndex: integer (int32)
in query

(no description)

pageSize: integer (int32)
in query

(no description)

startDate: string (date-time)
in query

(no description)

endDate: string (date-time)
in query

(no description)

200 OK

Calendar

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "events": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "startDate": {
        "iso8601": "string",
        "ticks": "integer (int64)",
        "local": "string (date-time)"
      },
      "endDate": {
        "iso8601": "string",
        "ticks": "integer (int64)",
        "local": "string (date-time)"
      },
      "isAllDay": "boolean",
      "eventTypeId": "integer (int32)",
      "isRepeating": "boolean",
      "isMultiDay": "boolean"
    }
  ],
  "totalEvents": "integer (int32)",
  "eventTypes": [
    {
      "color": "string",
      "eventTypeId": "integer (int32)",
      "className": "string",
      "default": "boolean",
      "active": "boolean",
      "label": "object"
    }
  ],
  "body": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "creatorId": "integer (int32)",
  "ownerId": "integer (int32)",
  "parentId": "integer (int32)",
  "grandParentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean",
  "allowFiles": "boolean",
  "pageType": "string",
  "lastModifiedBy": "string"
}

GET /api/calendar/{contentId}/events

contentId: integer (int32)
in path

(no description)

startIndex: integer (int32)
in query

(no description)

pageSize: integer (int32)
in query

(no description)

startDate: string (date-time)
in query

(no description)

endDate: string (date-time)
in query

(no description)

Calendar Events

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "events": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "startDate": {
        "iso8601": "string",
        "ticks": "integer (int64)",
        "local": "string (date-time)"
      },
      "endDate": {
        "iso8601": "string",
        "ticks": "integer (int64)",
        "local": "string (date-time)"
      },
      "isAllDay": "boolean",
      "eventTypeId": "integer (int32)",
      "isRepeating": "boolean",
      "isMultiDay": "boolean"
    }
  ],
  "totalEvents": "integer (int32)",
  "eventTypes": [
    {
      "color": "string",
      "eventTypeId": "integer (int32)",
      "className": "string",
      "default": "boolean",
      "active": "boolean",
      "label": "object"
    }
  ]
}

ApiCardData

POST /api/carddata

undefined

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "contentIds": [
    "integer (int32)"
  ],
  "cards": [
    "string"
  ]
}
200 OK

List of CardData

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "contentId": "integer (int32)",
  "cardDataItem": [
    {
      "result": "object",
      "portletKey": "string"
    }
  ]
}

ApiContent

GET /api/content

contentIds: string
in query

(no description)

200 OK

List of Content

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "body": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "creatorId": "integer (int32)",
  "ownerId": "integer (int32)",
  "parentId": "integer (int32)",
  "grandParentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean",
  "allowFiles": "boolean",
  "pageType": "string",
  "lastModifiedBy": "string"
}

POST /api/content

undefined

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "title": "string",
  "body": "string",
  "culture": "string",
  "parentId": "integer (int32)",
  "isPublished": "boolean",
  "isArchived": "boolean",
  "pageType": "string",
  "linkUri": "string",
  "mailingListEmail": "string",
  "startDate": "string",
  "endDate": "string",
  "isAllDay": "boolean",
  "eventTypeId": "integer (int32)"
}
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "result": "string",
  "entity": {
    "body": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "contentId": "integer (int32)",
    "title": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "abbreviatedTitle": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "summary": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "dateModified": "string (date-time)",
    "datePosted": "string (date-time)",
    "datePublished": "string (date-time)",
    "modifiedId": "integer (int32)",
    "creatorId": "integer (int32)",
    "ownerId": "integer (int32)",
    "parentId": "integer (int32)",
    "grandParentId": "integer (int32)",
    "treePath": "string",
    "treePathItems": [
      {
        "contentId": "integer (int32)",
        "title": "string",
        "url": "string"
      }
    ],
    "treePathText": "string",
    "permissionIsEdit": "boolean",
    "permissionIsView": "boolean",
    "isPublished": "boolean",
    "isPrivate": "boolean",
    "isArchived": "boolean",
    "isUpdated": "boolean",
    "allowFiles": "boolean",
    "pageType": "string",
    "lastModifiedBy": "string"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

GET /api/content/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Content

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "body": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "creatorId": "integer (int32)",
  "ownerId": "integer (int32)",
  "parentId": "integer (int32)",
  "grandParentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean",
  "allowFiles": "boolean",
  "pageType": "string",
  "lastModifiedBy": "string"
}

DELETE /api/content/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

PATCH /api/content/{contentId}

undefined

contentId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "title": "string",
  "body": "string",
  "culture": "string",
  "parentId": "integer (int32)",
  "isPublished": "boolean",
  "isArchived": "boolean",
  "pageType": "string",
  "linkUri": "string",
  "mailingListEmail": "string",
  "startDate": "string",
  "endDate": "string",
  "isAllDay": "boolean",
  "eventTypeId": "integer (int32)"
}
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "result": "string",
  "entity": {
    "body": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "contentId": "integer (int32)",
    "title": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "abbreviatedTitle": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "summary": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "dateModified": "string (date-time)",
    "datePosted": "string (date-time)",
    "datePublished": "string (date-time)",
    "modifiedId": "integer (int32)",
    "creatorId": "integer (int32)",
    "ownerId": "integer (int32)",
    "parentId": "integer (int32)",
    "grandParentId": "integer (int32)",
    "treePath": "string",
    "treePathItems": [
      {
        "contentId": "integer (int32)",
        "title": "string",
        "url": "string"
      }
    ],
    "treePathText": "string",
    "permissionIsEdit": "boolean",
    "permissionIsView": "boolean",
    "isPublished": "boolean",
    "isPrivate": "boolean",
    "isArchived": "boolean",
    "isUpdated": "boolean",
    "allowFiles": "boolean",
    "pageType": "string",
    "lastModifiedBy": "string"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

POST /api/content/{contentId}/changeowner

undefined

contentId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "userId": "integer (int32)"
}
200 OK

Success

GET /api/content/{contentId}/children

contentId: integer (int32)
in path

(no description)

200 OK

List of Content

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "body": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "creatorId": "integer (int32)",
  "ownerId": "integer (int32)",
  "parentId": "integer (int32)",
  "grandParentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean",
  "allowFiles": "boolean",
  "pageType": "string",
  "lastModifiedBy": "string"
}

GET /api/content/{contentId}/parents

contentId: integer (int32)
in path

(no description)

200 OK

List of Content

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "body": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "creatorId": "integer (int32)",
  "ownerId": "integer (int32)",
  "parentId": "integer (int32)",
  "grandParentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean",
  "allowFiles": "boolean",
  "pageType": "string",
  "lastModifiedBy": "string"
}

GET /api/content/{contentId}/tags

contentId: integer (int32)
in path

(no description)

200 OK

List of ContentTag

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "contentId": "integer (int32)",
  "tagId": "integer (int32)",
  "name": "string",
  "usage": "integer (int32)",
  "tagBundleId": "integer (int32)",
  "tagBundleLabel": "string"
}

POST /api/content/{contentId}/tags

string
contentId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
[
  "string"
]
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "result": "string",
  "entity": [
    {
      "contentId": "integer (int32)",
      "tagId": "integer (int32)",
      "name": "string",
      "usage": "integer (int32)",
      "tagBundleId": "integer (int32)",
      "tagBundleLabel": "string"
    }
  ],
  "message": "string",
  "errors": [
    "string"
  ]
}

DELETE /api/content/{contentId}/tags

contentId: integer (int32)
in path

(no description)

200 OK

Success

DELETE /api/content/{contentId}/tags/{tagId}

contentId: integer (int32)
in path

(no description)

tagId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/content/{contentId}/activity

contentId: integer (int32)
in path

(no description)

List of ActivityItemModel

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "userId": "integer (int32)",
  "contentId": "integer (int32)",
  "activityId": "integer (int32)",
  "activityType": "string",
  "message": "string",
  "dateCreated": "string (date-time)"
}

GET /api/content/{contentId}/portlets/{culture}

contentId: integer (int32)
in path

(no description)

culture: string
in query

(no description)

200 OK

Success

GET /api/content/{contentId}/permissions

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/content/{contentId}/followers

contentId: integer (int32)
in path

(no description)

200 OK

Success

POST /api/content/{contentId}/followers

integer (int32)
contentId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
[
  "integer (int32)"
]
200 OK

Success

DELETE /api/content/{contentId}/followers

contentId: integer (int32)
in path

(no description)

userIds: integer[]
in query

(no description)

Array values passed as multiple parameters: ?userIds=aaa&userIds=bbb
200 OK

Success

GET /api/content/{contentId}/ancestors

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/content/{contentId}/likes

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/content/{contentId}/comments

contentId: integer (int32)
in path

(no description)

200 OK

Success

POST /api/content/{contentId}/like

contentId: integer (int32)
in path

(no description)

200 OK

Success

DELETE /api/content/{contentId}/like

contentId: integer (int32)
in path

(no description)

200 OK

Success

POST /api/content/{id}/clone/{destinationId}

id: integer (int32)
in path

(no description)

destinationId: integer (int32)
in path

(no description)

200 OK

Success

ApiCustomPortlet

GET /api/customportlets/{portletTemplateId}

portletTemplateId: integer (int32)
in path

(no description)

200 OK

Success

PATCH /api/customportlets/{portletTemplateId}

portletTemplateId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "portletTemplateId": "integer (int32)",
  "serverTemplate": "string",
  "clientTemplate": "string",
  "styleTemplate": "string",
  "isCurrent": "boolean"
}
200 OK

Success

GET /api/customportlets/{portletTemplateId}/data

portletTemplateId: integer (int32)
in path

(no description)

likeKey: string
in query

(no description)

200 OK

Success

PUT /api/customportlets/{portletTemplateId}/data

string
portletTemplateId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
"object"
200 OK

Success

DELETE /api/customportlets/{portletTemplateId}/data

portletTemplateId: integer (int32)
in path

(no description)

likeKey: string
in query

(no description)

200 OK

Success

GET /api/customportlets/{portletTemplateId}/data/{key}

portletTemplateId: integer (int32)
in path

(no description)

key: string
in path

(no description)

200 OK

Success

DELETE /api/customportlets/{portletTemplateId}/data/{key}

portletTemplateId: integer (int32)
in path

(no description)

key: string
in path

(no description)

200 OK

Success

POST /api/customportlets/{portletTemplateId}/upgrade

portletTemplateId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/customportlets/{portletTemplateId}/pages

portletTemplateId: integer (int32)
in path

(no description)

200 OK

ContentId of Pages using Portlet (portletTemplateId)

type
integer (int32)
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
"integer (int32)"

GET /api/customportlets/{portletTemplateId}/pages/{contentId}

portletTemplateId: integer (int32)
in path

(no description)

contentId: integer (int32)
in path

(no description)

200 OK

Is Porlet (portletTemplateId) used on Page (contentId)

type
boolean
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
"boolean"

ApiDocuments

GET /api/documents/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/documents/{contentId}/data

contentId: integer (int32)
in path

(no description)

200 OK

Success

POST /api/documents

parentId: integer (int32)
in query

(no description)

overwriteExisting: boolean
in query

(no description)

allowDuplicateds: boolean
in query

(no description)

inheritOwner: boolean
in query

(no description)

culture: string
in query

(no description)

title: string
in query

(no description)

body: string
in query

(no description)

200 OK

Success

POST /api/document/{contentId}/update

contentId: integer (int32)
in path

(no description)

retainLock: boolean
in formData

(no description)

200 OK

Success

POST /api/document/add

200 OK

Success

GET /api/document/getall/{contentIds}

contentIds: string
in query

(no description)

200 OK

Success

GET /api/document/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/document/edit/file/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

POST /api/document/replace/file/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/document/edit/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/document/unlock/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/document/lock/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

ApiExcel

GET /api/custom/excel/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

ApiFeaturedImage

GET /api/featuredimage

imageCropType: string None, Profile, Thumbnail, NewsGrid, Square, Carousel, VideoThumbnail
in query

(no description)

contentIds: string
in query

(no description)

fallBackToParent: boolean
in query

(no description)

size: integer (int32)
in query

(no description)

200 OK

Success

ApiFollowing

POST /api/following

undefined

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "contentIds": [
    "integer (int32)"
  ],
  "userIds": [
    "integer (int32)"
  ]
}
200 OK

Success

ApiGroup

GET /api/groups/{contentId}/users

contentId: integer (int32)
in path

(no description)

200 OK

List of User

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "userId": "integer (int32)",
  "contentId": "integer (int32)",
  "firstName": "string",
  "lastName": "string",
  "preferredName": "string",
  "salutation": "string",
  "email": "string",
  "username": "string",
  "jobTitle": "string",
  "timeZone": "string",
  "defaultCulture": "string",
  "birthday": "string",
  "birthdayDateTime": "string",
  "createdDate": "string (date-time)",
  "modifiedDate": "string (date-time)",
  "phoneNumbers": {
    "fax": "string",
    "mobile": "string",
    "tel": "string"
  },
  "images": {
    "small": "string",
    "medium": "string",
    "large": "string"
  },
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "manager": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "fullName": "string",
    "imageUrl": "string",
    "url": "string",
    "isActive": "boolean"
  },
  "customFields": [
    {
      "customFieldId": "integer (int32)",
      "type": "string",
      "name": "string",
      "value": "object",
      "text": "string",
      "editable": "boolean",
      "label": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "groups": [
    {
      "name": "string",
      "contentId": "integer (int32)",
      "groupTypeId": "integer (int32)"
    }
  ],
  "isActive": "boolean"
}

POST /api/groups/{contentId}/users

integer (int32)
contentId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
[
  "integer (int32)"
]

GroupAddUsersViewModel

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "added": [
    {
      "userId": "integer (int32)",
      "contentId": "integer (int32)",
      "firstName": "string",
      "lastName": "string",
      "preferredName": "string",
      "salutation": "string",
      "email": "string",
      "username": "string",
      "jobTitle": "string",
      "timeZone": "string",
      "defaultCulture": "string",
      "birthday": "string",
      "birthdayDateTime": "string",
      "createdDate": "string (date-time)",
      "modifiedDate": "string (date-time)",
      "phoneNumbers": {
        "fax": "string",
        "mobile": "string",
        "tel": "string"
      },
      "images": {
        "small": "string",
        "medium": "string",
        "large": "string"
      },
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "addressLine4": "string",
      "manager": {
        "userId": "integer (int32)",
        "contentId": "integer (int32)",
        "fullName": "string",
        "imageUrl": "string",
        "url": "string",
        "isActive": "boolean"
      },
      "customFields": [
        {
          "customFieldId": "integer (int32)",
          "type": "string",
          "name": "string",
          "value": "object",
          "text": "string",
          "editable": "boolean",
          "label": [
            {
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "groups": [
        {
          "name": "string",
          "contentId": "integer (int32)",
          "groupTypeId": "integer (int32)"
        }
      ],
      "isActive": "boolean"
    }
  ],
  "failed": [
    "integer (int32)"
  ]
}

GET /api/groups/{contentId}/users/{userId}

contentId: integer (int32)
in path

(no description)

userId: integer (int32)
in path

(no description)

200 OK

Success

DELETE /api/groups/{contentId}/users/{userId}

contentId: integer (int32)
in path

(no description)

userId: integer (int32)
in path

(no description)

200 OK

Success

ApiGroupType

GET /api/grouptype

inUseOnly: boolean
in query

(no description)

200 OK

List of GroupType

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "label": "string",
  "culture": "string",
  "groupTypeId": "integer (int32)",
  "sortOrder": "integer (int32)",
  "isPermanent": "boolean",
  "usingFallBackLabel": "boolean"
}

ApiHome

Requests must include the password parameter or an Authorization header can be set with a REST API authentication token. Returns a token for the requested user that can be passed into the other API calls to represent that user.

POST /api/authenticate
Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "username": "string",
  "password": "string",
  "authenticationToken": "string",
  "applicationId": "string",
  "impersonateUserId": "integer (int32)"
}
200 OK

Token

type
string
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
"string"

Will allow administrators to impersonate another user for API calls. It requires authentication of an admin username and password and a userID of the requested user for impersonation. Returns a token for the impersonated user that can be passed into the other API calls to represent that user.

POST /api/impersonate
Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "username": "string",
  "password": "string",
  "authenticationToken": "string",
  "applicationId": "string",
  "impersonateUserId": "integer (int32)"
}
200 OK

Token

type
string
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
"string"

GET /api/customfields

Custom fields

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "groupName": "string",
  "customFieldId": "integer (int32)",
  "customFieldName": "string",
  "type": "string",
  "editable": "boolean"
}

GET /api/configuration

200 OK

Configuration

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "apiMustUseHttps": "boolean",
  "name": "string",
  "title": "string",
  "homeRecentActivityEnablePolling": "boolean",
  "homeRecentActivityPollingInterval": "integer (int32)",
  "desktopConnectorEnabled": "boolean",
  "uploadingSettings": {
    "blacklist": [
      "string"
    ],
    "whitelist": [
      "string"
    ]
  },
  "version": "string"
}

ApiNavigation

GET /api/navigation/{parentContentId}/children

parentContentId: integer (int32)
in path

(no description)

depth: integer (int32)
in query

(no description)

contentIdsFilter: string
in query

(no description)

applyNavigationContentTypeFilter: boolean
in query

(no description)

includeArchivedContent: boolean
in query

(no description)

200 OK

Success

POST /api/navigation/{parentContentId}/children

parentContentId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "depth": "integer (int32)",
  "contentIdsFilter": [
    "integer (int32)"
  ],
  "applyNavigationContentTypeFilter": "boolean",
  "includeArchivedContent": "boolean"
}
200 OK

Success

ApiNewsFeed

POST /api/newsfeed

undefined

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "contentIds": [
    "integer (int32)"
  ],
  "groupTypeIds": [
    "integer (int32)"
  ],
  "pageSize": "integer (int32)",
  "startIndex": "integer (int32)",
  "showArchived": "boolean"
}
200 OK

Success

ApiNotifications

POST /api/notifications/email

200 OK

Success

ApiSearch

POST /api/search

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "excludeContentIds": [
    "integer (int32)"
  ],
  "excludePageTypes": [
    "string"
  ],
  "excludeTreePath": [
    "integer (int32)"
  ],
  "forArea": "string",
  "forCulture": "string",
  "forEditedBy": [
    "integer (int32)"
  ],
  "forMentioned": [
    "integer (int32)"
  ],
  "forRequireAllUsersMentioned": "boolean",
  "forFirstLetterOfTitle": "string",
  "forOwnedBy": [
    "integer (int32)"
  ],
  "forPostedDate": "string",
  "forPublishedDate": "string",
  "forQuery": "string",
  "forSearchType": "string",
  "forTags": [
    "integer (int32)"
  ],
  "includeArchived": "boolean",
  "includeInactiveUsers": "boolean",
  "includeComments": "boolean",
  "includePageTypes": [
    "string"
  ],
  "sortType": "string",
  "sortDirection": "string",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)",
  "scope": "integer (int32)"
}
200 OK

Success

POST /api/search/users

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "forQuery": "string",
  "forTags": [
    "integer (int32)"
  ],
  "forGroups": [
    "integer (int32)"
  ],
  "forFirstLetterOfLastName": "string",
  "forCustomFields": "object",
  "forCustomFieldDates": "object",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)",
  "sortType": "string",
  "sortDirection": "string"
}
200 OK

Success

POST /api/search/groups

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "forQuery": "string",
  "forTags": [
    "integer (int32)"
  ],
  "includeArchived": "boolean",
  "forFirstLetterOfTitle": "string",
  "forGroupTypes": [
    "integer (int32)"
  ],
  "forOwnedBy": [
    "integer (int32)"
  ],
  "forPublishedDate": "string",
  "sortType": "string",
  "sortDirection": "string",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}
200 OK

Success

POST /api/search/index/{contentId}

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/search/boosts/{searchArea}

searchArea: string General, Forum, Groups, People, NewsBlog, TitleOnly, PhotoGallery, BestBets, Polls, ShoutOuts, UserName, GroupTitle
in path

(no description)

200 OK

Success

GET /api/search/popularity

200 OK

Success

GET /api/search/update-popularity

200 OK

Success

ApiSecurityGroup

GET /api/securitygroup

pageSize: integer (int32)
in query

(no description)

pageNumber: integer (int32)
in query

(no description)

securityGroupType: string System, Regular, ActiveDirectoryMapped, None
in query

(no description)

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "items": [
    {
      "id": "integer (int32)",
      "sortOrder": "integer (int32)",
      "name": "string",
      "isPermanent": "boolean",
      "isEditable": "boolean",
      "lastSyncTime": "string (date-time)",
      "externalStoreGroupName": "string",
      "serviceUniqueIdentifier": "string (uuid)",
      "syncStatus": "string",
      "userCount": "integer (int32)",
      "securingCount": "integer (int32)",
      "contentId": "integer (int32)",
      "securityGroupType": "string"
    }
  ],
  "totalItems": "integer (int32)"
}

POST /api/securitygroup

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "name": "string"
}
200 OK

Success

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "id": "integer (int32)",
  "sortOrder": "integer (int32)",
  "name": "string",
  "isPermanent": "boolean",
  "isEditable": "boolean",
  "lastSyncTime": "string (date-time)",
  "externalStoreGroupName": "string",
  "serviceUniqueIdentifier": "string (uuid)",
  "syncStatus": "string",
  "userCount": "integer (int32)",
  "securingCount": "integer (int32)",
  "contentId": "integer (int32)",
  "securityGroupType": "string"
}

GET /api/securitygroup/{id}

id: integer (int32)
in path

(no description)

200 OK

Success

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "id": "integer (int32)",
  "sortOrder": "integer (int32)",
  "name": "string",
  "isPermanent": "boolean",
  "isEditable": "boolean",
  "lastSyncTime": "string (date-time)",
  "externalStoreGroupName": "string",
  "serviceUniqueIdentifier": "string (uuid)",
  "syncStatus": "string",
  "userCount": "integer (int32)",
  "securingCount": "integer (int32)",
  "contentId": "integer (int32)",
  "securityGroupType": "string"
}

GET /api/securitygroup/{id}/members

id: integer (int32)
in path

(no description)

pageSize: integer (int32)
in query

(no description)

pageNumber: integer (int32)
in query

(no description)

Success

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "items": [
    {
      "userId": "integer (int32)",
      "contentId": "integer (int32)",
      "firstName": "string",
      "lastName": "string",
      "preferredName": "string",
      "salutation": "string",
      "email": "string",
      "username": "string",
      "jobTitle": "string",
      "timeZone": "string",
      "defaultCulture": "string",
      "birthday": "string",
      "birthdayDateTime": "string",
      "createdDate": "string (date-time)",
      "modifiedDate": "string (date-time)",
      "phoneNumbers": {
        "fax": "string",
        "mobile": "string",
        "tel": "string"
      },
      "images": {
        "small": "string",
        "medium": "string",
        "large": "string"
      },
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "addressLine4": "string",
      "manager": {
        "userId": "integer (int32)",
        "contentId": "integer (int32)",
        "fullName": "string",
        "imageUrl": "string",
        "url": "string",
        "isActive": "boolean"
      },
      "customFields": [
        {
          "customFieldId": "integer (int32)",
          "type": "string",
          "name": "string",
          "value": "object",
          "text": "string",
          "editable": "boolean",
          "label": [
            {
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "groups": [
        {
          "name": "string",
          "contentId": "integer (int32)",
          "groupTypeId": "integer (int32)"
        }
      ],
      "isActive": "boolean"
    }
  ],
  "totalItems": "integer (int32)"
}

POST /api/securitygroup/{id}/members

integer (int32)
id: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
[
  "integer (int32)"
]
200 OK

Success

DELETE /api/securitygroup/{id}/members

integer (int32)
id: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
[
  "integer (int32)"
]
200 OK

Success

Returns true if user is a member of securitygroup

GET /api/securitygroup/{id}/members/{userId}
id: integer (int32)
in path

(no description)

userId: integer (int32)
in path

(no description)

200 OK

IsMember

type
boolean
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
"boolean"

ApiStaleContent

POST /api/stalecontent

undefined

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "numberOfTimesViewed": "integer (int32)",
  "lengthOfPeriod": "integer (int32)",
  "period": "string",
  "contentIdToSearchUnder": "integer (int32)",
  "excludedUserIds": [
    "integer (int32)"
  ],
  "sortOrder": "string",
  "sortDirection": "string",
  "query": "string",
  "selectedContentIds": [
    "integer (int32)"
  ],
  "includeArchived": "boolean",
  "pageNumber": "integer (int32)",
  "pageSize": "integer (int32)"
}
200 OK

Success

POST /api/stalecontent/{contentId}

contentId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "numberOfTimesViewed": "integer (int32)",
  "lengthOfPeriod": "integer (int32)",
  "period": "string",
  "includeArchivedContent": "boolean",
  "pageNumber": "integer (int32)",
  "pageSize": "integer (int32)",
  "sortDirection": "string",
  "sortOrder": "string"
}
200 OK

Success

ApiStats

POST /api/stats/users/{userId}/mostliked

undefined

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "items": [
    {
      "content": {
        "contentId": "integer (int32)",
        "title": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "abbreviatedTitle": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "summary": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "dateModified": "string (date-time)",
        "datePosted": "string (date-time)",
        "datePublished": "string (date-time)",
        "modifiedId": "integer (int32)",
        "ownerId": "integer (int32)",
        "creatorId": "integer (int32)",
        "parentId": "integer (int32)",
        "treePath": "string",
        "treePathItems": [
          {
            "contentId": "integer (int32)",
            "title": "string",
            "url": "string"
          }
        ],
        "treePathText": "string",
        "permissionIsEdit": "boolean",
        "permissionIsView": "boolean",
        "isPublished": "boolean",
        "isPrivate": "boolean",
        "isArchived": "boolean",
        "isUpdated": "boolean"
      },
      "count": "integer (int32)"
    }
  ],
  "totalItems": "integer (int32)"
}

POST /api/stats/users/{userId}/mostcommented

undefined

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "items": [
    {
      "content": {
        "contentId": "integer (int32)",
        "title": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "abbreviatedTitle": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "summary": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "dateModified": "string (date-time)",
        "datePosted": "string (date-time)",
        "datePublished": "string (date-time)",
        "modifiedId": "integer (int32)",
        "ownerId": "integer (int32)",
        "creatorId": "integer (int32)",
        "parentId": "integer (int32)",
        "treePath": "string",
        "treePathItems": [
          {
            "contentId": "integer (int32)",
            "title": "string",
            "url": "string"
          }
        ],
        "treePathText": "string",
        "permissionIsEdit": "boolean",
        "permissionIsView": "boolean",
        "isPublished": "boolean",
        "isPrivate": "boolean",
        "isArchived": "boolean",
        "isUpdated": "boolean"
      },
      "count": "integer (int32)"
    }
  ],
  "totalItems": "integer (int32)"
}

POST /api/stats/users/{userId}/owned

undefined

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "orderBy": "string",
  "sortDirection": "string",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}

Success

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "items": [
    {
      "contentId": "integer (int32)",
      "title": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "abbreviatedTitle": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "summary": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "dateModified": "string (date-time)",
      "datePosted": "string (date-time)",
      "datePublished": "string (date-time)",
      "modifiedId": "integer (int32)",
      "ownerId": "integer (int32)",
      "creatorId": "integer (int32)",
      "parentId": "integer (int32)",
      "treePath": "string",
      "treePathItems": [
        {
          "contentId": "integer (int32)",
          "title": "string",
          "url": "string"
        }
      ],
      "treePathText": "string",
      "permissionIsEdit": "boolean",
      "permissionIsView": "boolean",
      "isPublished": "boolean",
      "isPrivate": "boolean",
      "isArchived": "boolean",
      "isUpdated": "boolean"
    }
  ],
  "totalItems": "integer (int32)"
}

POST /api/stats/actions/user

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "userIds": [
    "integer (int32)"
  ],
  "groupIds": [
    "integer (int32)"
  ],
  "securityGroupIds": [
    "integer (int32)"
  ],
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "items": [
    {
      "fullName": "string",
      "userId": "integer (int32)",
      "edits": "integer (int32)",
      "profileEdits": "integer (int32)",
      "creates": "integer (int32)",
      "searches": "integer (int32)",
      "comments": "integer (int32)",
      "likes": "integer (int32)",
      "bookmarks": "integer (int32)",
      "blogPosts": "integer (int32)",
      "forumPosts": "integer (int32)",
      "forumComments": "integer (int32)",
      "microBlogEntry": "integer (int32)",
      "attachments": "integer (int32)",
      "groupCount": "integer (int32)",
      "pollVotes": "integer (int32)",
      "follows": "integer (int32)",
      "mentions": "integer (int32)",
      "shoutOuts": "integer (int32)",
      "shoutOutsReceived": "integer (int32)",
      "profileCompletePercent": "number (float)"
    }
  ],
  "totalItems": "integer (int32)"
}

POST /api/stats/actions/user/{userId}

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}

Success

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "fullName": "string",
  "userId": "integer (int32)",
  "edits": "integer (int32)",
  "profileEdits": "integer (int32)",
  "creates": "integer (int32)",
  "searches": "integer (int32)",
  "comments": "integer (int32)",
  "likes": "integer (int32)",
  "bookmarks": "integer (int32)",
  "blogPosts": "integer (int32)",
  "forumPosts": "integer (int32)",
  "forumComments": "integer (int32)",
  "microBlogEntry": "integer (int32)",
  "attachments": "integer (int32)",
  "groupCount": "integer (int32)",
  "pollVotes": "integer (int32)",
  "follows": "integer (int32)",
  "mentions": "integer (int32)",
  "shoutOuts": "integer (int32)",
  "shoutOutsReceived": "integer (int32)",
  "profileCompletePercent": "number (float)"
}

POST /api/stats/actions/page

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "ownedByUserIds": [
    "integer (int32)"
  ],
  "pageTypes": [
    "string"
  ],
  "sectionIds": [
    "integer (int32)"
  ],
  "contentIds": [
    "integer (int32)"
  ],
  "userIds": [
    "integer (int32)"
  ],
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "items": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "views": "integer (int32)",
      "uniqueViews": "integer (int32)",
      "creates": "integer (int32)",
      "edits": "integer (int32)",
      "downloads": "integer (int32)",
      "uniqueDownloads": "integer (int32)",
      "likes": "integer (int32)",
      "follows": "integer (int32)",
      "comments": "integer (int32)",
      "bookmarks": "integer (int32)",
      "shares": "integer (int32)",
      "lastViewed": "string (date-time)",
      "lastDownloaded": "string (date-time)",
      "modifiedDate": "string (date-time)",
      "isArchived": "boolean",
      "isPublished": "boolean"
    }
  ],
  "totalItems": "integer (int32)"
}

ApiTheme

GET /api/theme/variables

200 OK

Theme CSS

type
string
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
"string"

ApiUsers

GET /api/users

userIds: string
in query

Include only specified userIds. Maximum recommended length is 100 userIds. Example: '1,2,3,4,5'

contentIds: string
in query

Include only specified contentIds. Maximum recommended length is 100 contentIds. Example: '15567,1678,1'

extraFields: string
in query

Extra fields to include in response. Custom fields can be specified by label or Id. Example: 'Manager,Address,Groups,Anniversary'

includeInactive: boolean
in query

Include inactive users. If not supplied the default is false and no inactive users will be returned. Only admins are able to see inactive users. Returns 403 for non-admins.

200 OK

List of User

401 Unauthorized

Non-admins cannot view inactive users.

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "userId": "integer (int32)",
  "contentId": "integer (int32)",
  "firstName": "string",
  "lastName": "string",
  "preferredName": "string",
  "salutation": "string",
  "email": "string",
  "username": "string",
  "jobTitle": "string",
  "timeZone": "string",
  "defaultCulture": "string",
  "birthday": "string",
  "birthdayDateTime": "string",
  "createdDate": "string (date-time)",
  "modifiedDate": "string (date-time)",
  "phoneNumbers": {
    "fax": "string",
    "mobile": "string",
    "tel": "string"
  },
  "images": {
    "small": "string",
    "medium": "string",
    "large": "string"
  },
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "manager": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "fullName": "string",
    "imageUrl": "string",
    "url": "string",
    "isActive": "boolean"
  },
  "customFields": [
    {
      "customFieldId": "integer (int32)",
      "type": "string",
      "name": "string",
      "value": "object",
      "text": "string",
      "editable": "boolean",
      "label": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "groups": [
    {
      "name": "string",
      "contentId": "integer (int32)",
      "groupTypeId": "integer (int32)"
    }
  ],
  "isActive": "boolean"
}

POST /api/users

undefined

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "username": "string",
  "userServiceUniqueIdentifier": "string",
  "authenticationStore": "string"
}

SaveEntityResponse

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "result": "string",
  "entity": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "firstName": "string",
    "lastName": "string",
    "preferredName": "string",
    "salutation": "string",
    "email": "string",
    "username": "string",
    "jobTitle": "string",
    "timeZone": "string",
    "defaultCulture": "string",
    "birthday": "string",
    "birthdayDateTime": "string",
    "createdDate": "string (date-time)",
    "modifiedDate": "string (date-time)",
    "phoneNumbers": {
      "fax": "string",
      "mobile": "string",
      "tel": "string"
    },
    "images": {
      "small": "string",
      "medium": "string",
      "large": "string"
    },
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressLine4": "string",
    "manager": {
      "userId": "integer (int32)",
      "contentId": "integer (int32)",
      "fullName": "string",
      "imageUrl": "string",
      "url": "string",
      "isActive": "boolean"
    },
    "customFields": [
      {
        "customFieldId": "integer (int32)",
        "type": "string",
        "name": "string",
        "value": "object",
        "text": "string",
        "editable": "boolean",
        "label": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    ],
    "groups": [
      {
        "name": "string",
        "contentId": "integer (int32)",
        "groupTypeId": "integer (int32)"
      }
    ],
    "isActive": "boolean"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

GET /api/users/{userId}

userId: integer (int32)
in path

(no description)

extraFields: string
in query

(no description)

200 OK

User

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "userId": "integer (int32)",
  "contentId": "integer (int32)",
  "firstName": "string",
  "lastName": "string",
  "preferredName": "string",
  "salutation": "string",
  "email": "string",
  "username": "string",
  "jobTitle": "string",
  "timeZone": "string",
  "defaultCulture": "string",
  "birthday": "string",
  "birthdayDateTime": "string",
  "createdDate": "string (date-time)",
  "modifiedDate": "string (date-time)",
  "phoneNumbers": {
    "fax": "string",
    "mobile": "string",
    "tel": "string"
  },
  "images": {
    "small": "string",
    "medium": "string",
    "large": "string"
  },
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "manager": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "fullName": "string",
    "imageUrl": "string",
    "url": "string",
    "isActive": "boolean"
  },
  "customFields": [
    {
      "customFieldId": "integer (int32)",
      "type": "string",
      "name": "string",
      "value": "object",
      "text": "string",
      "editable": "boolean",
      "label": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "groups": [
    {
      "name": "string",
      "contentId": "integer (int32)",
      "groupTypeId": "integer (int32)"
    }
  ],
  "isActive": "boolean"
}

PATCH /api/users/{userId}

undefined

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "salutation": "string",
  "preferredName": "string",
  "profileText": "string",
  "jobTitle": "string",
  "phoneTel": "string",
  "phoneMobile": "string",
  "phoneFax": "string",
  "timeZone": "string",
  "defaultCulture": "string",
  "birthday": "string (date-time)",
  "birthdayDisplay": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string"
}

SaveEntityResponse

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "result": "string",
  "entity": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "firstName": "string",
    "lastName": "string",
    "preferredName": "string",
    "salutation": "string",
    "email": "string",
    "username": "string",
    "jobTitle": "string",
    "timeZone": "string",
    "defaultCulture": "string",
    "birthday": "string",
    "birthdayDateTime": "string",
    "createdDate": "string (date-time)",
    "modifiedDate": "string (date-time)",
    "phoneNumbers": {
      "fax": "string",
      "mobile": "string",
      "tel": "string"
    },
    "images": {
      "small": "string",
      "medium": "string",
      "large": "string"
    },
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressLine4": "string",
    "manager": {
      "userId": "integer (int32)",
      "contentId": "integer (int32)",
      "fullName": "string",
      "imageUrl": "string",
      "url": "string",
      "isActive": "boolean"
    },
    "customFields": [
      {
        "customFieldId": "integer (int32)",
        "type": "string",
        "name": "string",
        "value": "object",
        "text": "string",
        "editable": "boolean",
        "label": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    ],
    "groups": [
      {
        "name": "string",
        "contentId": "integer (int32)",
        "groupTypeId": "integer (int32)"
      }
    ],
    "isActive": "boolean"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

GET /api/users/current

200 OK

User

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "userId": "integer (int32)",
  "contentId": "integer (int32)",
  "firstName": "string",
  "lastName": "string",
  "preferredName": "string",
  "salutation": "string",
  "email": "string",
  "username": "string",
  "jobTitle": "string",
  "timeZone": "string",
  "defaultCulture": "string",
  "birthday": "string",
  "birthdayDateTime": "string",
  "createdDate": "string (date-time)",
  "modifiedDate": "string (date-time)",
  "phoneNumbers": {
    "fax": "string",
    "mobile": "string",
    "tel": "string"
  },
  "images": {
    "small": "string",
    "medium": "string",
    "large": "string"
  },
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "manager": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "fullName": "string",
    "imageUrl": "string",
    "url": "string",
    "isActive": "boolean"
  },
  "customFields": [
    {
      "customFieldId": "integer (int32)",
      "type": "string",
      "name": "string",
      "value": "object",
      "text": "string",
      "editable": "boolean",
      "label": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "groups": [
    {
      "name": "string",
      "contentId": "integer (int32)",
      "groupTypeId": "integer (int32)"
    }
  ],
  "isActive": "boolean"
}

POST /api/users/username

username: string
in query

(no description)

200 OK

User

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "userId": "integer (int32)",
  "contentId": "integer (int32)",
  "firstName": "string",
  "lastName": "string",
  "preferredName": "string",
  "salutation": "string",
  "email": "string",
  "username": "string",
  "jobTitle": "string",
  "timeZone": "string",
  "defaultCulture": "string",
  "birthday": "string",
  "birthdayDateTime": "string",
  "createdDate": "string (date-time)",
  "modifiedDate": "string (date-time)",
  "phoneNumbers": {
    "fax": "string",
    "mobile": "string",
    "tel": "string"
  },
  "images": {
    "small": "string",
    "medium": "string",
    "large": "string"
  },
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "manager": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "fullName": "string",
    "imageUrl": "string",
    "url": "string",
    "isActive": "boolean"
  },
  "customFields": [
    {
      "customFieldId": "integer (int32)",
      "type": "string",
      "name": "string",
      "value": "object",
      "text": "string",
      "editable": "boolean",
      "label": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "groups": [
    {
      "name": "string",
      "contentId": "integer (int32)",
      "groupTypeId": "integer (int32)"
    }
  ],
  "isActive": "boolean"
}

GET /api/users/{userId}/groups

userId: integer (int32)
in path

(no description)

200 OK

List of Detail

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "body": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "creatorId": "integer (int32)",
  "ownerId": "integer (int32)",
  "parentId": "integer (int32)",
  "grandParentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean",
  "allowFiles": "boolean",
  "pageType": "string",
  "lastModifiedBy": "string"
}

GET /api/users/{userId}/customfields

userId: integer (int32)
in path

(no description)

200 OK

List of CustomField

Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "customFieldId": "integer (int32)",
  "type": "string",
  "name": "string",
  "value": "object",
  "text": "string",
  "editable": "boolean",
  "label": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

PATCH /api/users/{userId}/customfields/{customFieldId}

undefined

userId: integer (int32)
in path

(no description)

customFieldId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "customFieldId": "integer (int32)",
  "type": "string",
  "name": "string",
  "value": "object",
  "text": "string",
  "editable": "boolean",
  "label": [
    {}
  ]
}
Response Content-Types: text/plain, application/json, text/json
Response Example (200 OK)
{
  "result": "string",
  "entity": {
    "customFieldId": "integer (int32)",
    "type": "string",
    "name": "string",
    "value": "object",
    "text": "string",
    "editable": "boolean",
    "label": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

PUT /api/user/id/{userId}/state

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{}
200 OK

Success

POST /api/user/id/{userId}/state

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{}
200 OK

Success

PUT /api/user/{userId}/state

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{}
200 OK

Success

POST /api/user/{userId}/state

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{}
200 OK

Success

GET /api/user/id/{userId}/state/{key}

userId: integer (int32)
in path

(no description)

key: string
in path

(no description)

200 OK

Success

GET /api/user/{userId}/state/{key}

userId: integer (int32)
in path

(no description)

key: string
in path

(no description)

200 OK

Success

GET /api/user/{userId}/manager

userId: integer (int32)
in path

(no description)

200 OK

Success

POST /api/user/{userId}/manager

undefined

userId: integer (int32)
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "userId": "integer (int32)"
}
200 OK

Success

DELETE /api/user/{userId}/manager

userId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/user/{userId}/alsoreportsto

userId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/user/{userId}/directreports

userId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/user/id/{userId}/photo

userId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/user/{userId}/photo

userId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/user/id/{userId}/photo/{width}/{height}/{cropped}

userId: integer (int32)
in path

(no description)

width: integer (int32)
in path

(no description)

height: integer (int32)
in path

(no description)

cropped: boolean
in query

(no description)

200 OK

Success

GET /api/user/{userId}/photo/{width}/{height}/{cropped}

userId: integer (int32)
in path

(no description)

width: integer (int32)
in path

(no description)

height: integer (int32)
in path

(no description)

cropped: boolean
in query

(no description)

200 OK

Success

GET /api/user/{userId}/customfield/{groupName}/{customFieldName}

userId: integer (int32)
in path

(no description)

groupName: string
in path

(no description)

customFieldName: string
in query

(no description)

200 OK

Success

POST /api/user/{userId}/customfield/{groupName}/{customFieldName}/updatetag

userId: integer (int32)
in path

(no description)

groupName: string
in path

(no description)

customFieldName: string
in path

(no description)

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
{
  "value": "string"
}
200 OK

Success

POST /api/user/id/{userId}/photo/update

userId: integer (int32)
in path

(no description)

fileName: string
in query

(no description)

contentType: string
in query

(no description)

cropData: string
in query

(no description)

200 OK

Success

POST /api/user/{userId}/photo/update

userId: integer (int32)
in path

(no description)

fileName: string
in query

(no description)

contentType: string
in query

(no description)

cropData: string
in query

(no description)

200 OK

Success

POST /api/user/{userId}/photo/delete

userId: integer (int32)
in path

(no description)

200 OK

Success

POST /api/user/id/{userId}/photo/delete

userId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/user/id/{userId}/status

userId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/user/{userId}/status

userId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/users/find/customField/{groupName}/{customFieldName}

groupName: string
in path

(no description)

customFieldName: string
in path

(no description)

value: string
in query

(no description)

200 OK

Success

GET /api/user/{userid}/canview/{contentid}

userId: integer (int32)
in path

(no description)

contentId: integer (int32)
in path

(no description)

200 OK

Success

GET /api/user/{userid}/canedit/{contentid}

userId: integer (int32)
in path

(no description)

contentId: integer (int32)
in path

(no description)

200 OK

Success

ApiUserStatus

POST /api/userstatus

Request Content-Types: application/json-patch+json, application/json, text/json, application/*+json
Request Example
[
  {
    "userId": "integer (int32)",
    "isActive": "boolean"
  }
]
200 OK

Success

Schema Definitions

Calendar: object

events: CalendarEvent
CalendarEvent
totalEvents: integer (int32)
eventTypes: CalendarEventType

The EventTypes present in the given Events

CalendarEventType
body: KeyValuePair[String,String]
KeyValuePair[String,String]
contentId: integer (int32)
title: KeyValuePair[String,String]
KeyValuePair[String,String]
abbreviatedTitle: KeyValuePair[String,String]
KeyValuePair[String,String]
summary: KeyValuePair[String,String]
KeyValuePair[String,String]
dateModified: string (date-time)
datePosted: string (date-time)
datePublished: string (date-time)
modifiedId: integer (int32)
creatorId: integer (int32)
ownerId: integer (int32)
parentId: integer (int32)
grandParentId: integer (int32)
treePath: string
treePathItems: PageHierarchyItem
PageHierarchyItem
treePathText: string
permissionIsEdit: boolean
permissionIsView: boolean
isPublished: boolean
isPrivate: boolean
isArchived: boolean
isUpdated: boolean
allowFiles: boolean
pageType: string
lastModifiedBy: string
Example
{
  "events": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "startDate": {
        "iso8601": "string",
        "ticks": "integer (int64)",
        "local": "string (date-time)"
      },
      "endDate": {
        "iso8601": "string",
        "ticks": "integer (int64)",
        "local": "string (date-time)"
      },
      "isAllDay": "boolean",
      "eventTypeId": "integer (int32)",
      "isRepeating": "boolean",
      "isMultiDay": "boolean"
    }
  ],
  "totalEvents": "integer (int32)",
  "eventTypes": [
    {
      "color": "string",
      "eventTypeId": "integer (int32)",
      "className": "string",
      "default": "boolean",
      "active": "boolean",
      "label": "object"
    }
  ],
  "body": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "creatorId": "integer (int32)",
  "ownerId": "integer (int32)",
  "parentId": "integer (int32)",
  "grandParentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean",
  "allowFiles": "boolean",
  "pageType": "string",
  "lastModifiedBy": "string"
}

CalendarEvent: object

contentId: integer (int32)
title: string
startDate: DatePortletModel
endDate: DatePortletModel
isAllDay: boolean
eventTypeId: integer (int32)
isRepeating: boolean
isMultiDay: boolean
Example
{
  "contentId": "integer (int32)",
  "title": "string",
  "startDate": {
    "iso8601": "string",
    "ticks": "integer (int64)",
    "local": "string (date-time)"
  },
  "endDate": {
    "iso8601": "string",
    "ticks": "integer (int64)",
    "local": "string (date-time)"
  },
  "isAllDay": "boolean",
  "eventTypeId": "integer (int32)",
  "isRepeating": "boolean",
  "isMultiDay": "boolean"
}

CalendarEventType: object

color: string
eventTypeId: integer (int32)
className: string
default: boolean
active: boolean
label: object
Example
{
  "color": "string",
  "eventTypeId": "integer (int32)",
  "className": "string",
  "default": "boolean",
  "active": "boolean",
  "label": "object"
}

KeyValuePair[String,String]: object

key: string
value: string
Example
{
  "key": "string",
  "value": "string"
}

PageHierarchyItem: object

contentId: integer (int32)
title: string
url: string
Example
{
  "contentId": "integer (int32)",
  "title": "string",
  "url": "string"
}

DatePortletModel: object

iso8601: string
ticks: integer (int64)
local: string (date-time)
Example
{
  "iso8601": "string",
  "ticks": "integer (int64)",
  "local": "string (date-time)"
}

CalendarEvents: object

events: CalendarEvent
CalendarEvent
totalEvents: integer (int32)
eventTypes: CalendarEventType

The EventTypes present in the given Events

CalendarEventType
Example
{
  "events": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "startDate": {
        "iso8601": "string",
        "ticks": "integer (int64)",
        "local": "string (date-time)"
      },
      "endDate": {
        "iso8601": "string",
        "ticks": "integer (int64)",
        "local": "string (date-time)"
      },
      "isAllDay": "boolean",
      "eventTypeId": "integer (int32)",
      "isRepeating": "boolean",
      "isMultiDay": "boolean"
    }
  ],
  "totalEvents": "integer (int32)",
  "eventTypes": [
    {
      "color": "string",
      "eventTypeId": "integer (int32)",
      "className": "string",
      "default": "boolean",
      "active": "boolean",
      "label": "object"
    }
  ]
}

CardDataRequest: object

contentIds: integer[]
integer (int32)
cards: string[]

None = 0 PageBody = 1 PageSummary = 2 Comments = 3 DocumentLibrary = 4 Core = 5 News = 6 NewsCarousel = 7 CompactDirectoryNavigation = 8 DetailedDirectoryNavigation = 9 GridNavigation = 11 DocumentDetails = 12 DocumentImagePreview = 13 CalendarDetails = 14 SearchOptions = 15 ContentBanner = 16 CalendarFilterCard = 17 PhotoGalleryDetails = 18 GroupMembers = 19 NewsBlogItemsList = 20 ShoutOutDetails = 21 ForumItemsList = 22 ForumStatistics = 23 ForumTopicDetails = 24 CalendarEventDetails = 25 MiniCalendar = 26 ChangePassword = 27 PollDetails = 28 PollList = 29 EmployeeDirectoryItemsList = 30 GroupDirectoryItemsList = 31 MailingListDetails = 32 MailingListThreadDetails = 33 ChangePasswordButton = 34 PageTitle = 35 Tags = 36 LikePageButton = 37 FollowPageButton = 38 EmailPageButton = 39 ExportPageButton = 40 BookmarkButton = 41 YourGroups = 42 ToggleCultureButton = 43 PageHeaderBranding = 44 VersionHistory = 45 RecentActivity = 46 PageOwnedBy = 48 PublishedDate = 49 UpdatedDate = 50 EditPageButton = 52 AddPageButton = 53 DeletePageButton = 54 ArchivePageButton = 55 MovePageButton = 56 IntranetStatistics = 57 DuplicatePageButton = 58 SuperNav = 59 CultureInfoWarningMessage = 60 RssLinks = 61 UnfollowFromEmail = 62 MicroBlogEntryDetails = 63 ActivityHistory = 64 RichText = 65 Poll = 66 RandomQuote = 67 CustomPortlet = 68 OwnerLocked = 71 ReorderNavigationButton = 72 ReorderFilesButton = 73 SecuritySettingsButton = 74 CrossSiteRequestForgeryToken = 75 Birthday = 76 GroupFilterCard = 77 SectionFilterCard = 78 QuickLinks = 79 PhotoGallery = 80 LocationInfo = 81 HomeMicroBlog = 82 ContentMicroBlog = 83 UsersGroups = 84 PostFilterCard = 85 NewsBlogFilterCard = 86 ForumFilterCard = 87 ProfileDetails = 88 SearchFilterCard = 89 SearchResults = 90 ProfileUserDetails = 91 GroupDirectoryFilterCard = 92 ReturnToLink = 93 EmployeeDirectoryFilterCard = 94 ProfileMicroBlog = 95 NotificationsHistory = 96 FollowingList = 97 FollowingFilterCard = 98 MainNavigation = 99 QuoteList = 100 Invitation = 101 ForgotPassword = 102 BookmarkManager = 103 PrivatePages = 104 GlobalCustomPortlet = 105 EventCalendar = 106 Disclaimer = 107 UrlCacheTokens = 108 Translate = 109 SharePointDocumentLibrary = 110 PhotoGalleryFilterCard = 111 SharePointSearchResults = 112 SharePointSearchFilterCard = 113 StaleTasksWarning = 114 StaleUserManagementTasksWarning = 115 ShoutOuts = 116 PollsFilterCard = 117 TermsConditions = 118 GoogleDrive = 119 PageSharing = 120 EditProfileSettings = 121 EditProfileSettingsButton = 122 ShoutOutHistoryFilterCard = 123 BulkUploaderToken = 124 ShoutOutHistory = 125 AdminTemplateUsage = 126 AdminTemplateUsageFilterCard = 127 RssNewsBlogList = 128 RssNewsBlogItems = 129 SessionInfo = 130

string None, PageBody, PageSummary, Comments, DocumentLibrary, Core, News, NewsCarousel, CompactDirectoryNavigation, DetailedDirectoryNavigation, GridNavigation, DocumentDetails, DocumentImagePreview, CalendarDetails, SearchOptions, ContentBanner, CalendarFilterCard, PhotoGalleryDetails, GroupMembers, NewsBlogItemsList, ShoutOutDetails, ForumItemsList, ForumStatistics, ForumTopicDetails, CalendarEventDetails, MiniCalendar, ChangePassword, PollDetails, PollList, EmployeeDirectoryItemsList, GroupDirectoryItemsList, MailingListDetails, MailingListThreadDetails, ChangePasswordButton, PageTitle, Tags, LikePageButton, FollowPageButton, EmailPageButton, ExportPageButton, BookmarkButton, YourGroups, ToggleCultureButton, PageHeaderBranding, VersionHistory, RecentActivity, FormDetails, PageOwnedBy, PublishedDate, UpdatedDate, FormCard, EditPageButton, AddPageButton, DeletePageButton, ArchivePageButton, MovePageButton, IntranetStatistics, DuplicatePageButton, SuperNav, CultureInfoWarningMessage, RssLinks, UnfollowFromEmail, MicroBlogEntryDetails, ActivityHistory, RichText, Poll, RandomQuote, CustomPortlet, OwnerLocked, ReorderNavigationButton, ReorderFilesButton, SecuritySettingsButton, CrossSiteRequestForgeryToken, Birthday, GroupFilterCard, SectionFilterCard, QuickLinks, PhotoGallery, LocationInfo, HomeMicroBlog, ContentMicroBlog, UsersGroups, PostFilterCard, NewsBlogFilterCard, ForumFilterCard, ProfileDetails, SearchFilterCard, SearchResults, ProfileUserDetails, GroupDirectoryFilterCard, ReturnToLink, EmployeeDirectoryFilterCard, ProfileMicroBlog, NotificationsHistory, FollowingList, FollowingFilterCard, MainNavigation, QuoteList, Invitation, ForgotPassword, BookmarkManager, PrivatePages, GlobalCustomPortlet, EventCalendar, Disclaimer, UrlCacheTokens, Translate, SharePointDocumentLibrary, PhotoGalleryFilterCard, SharePointSearchResults, SharePointSearchFilterCard, FormDataListFilterCard, StaleUserManagementTasksWarning, ShoutOuts, PollsFilterCard, TermsConditions, GoogleDrive, PageSharing, EditProfileSettings, EditProfileSettingsButton, ShoutOutHistoryFilterCard, BulkUploaderToken, ShoutOutHistory, AdminTemplateUsage, AdminTemplateUsageFilterCard, RssNewsBlogList, RssNewsBlogItems, SessionInfo, Office365, Office365SearchResults, AdminTagging, AdminTaggingFilterCard, GoogleDriveSearchResults
Example
{
  "contentIds": [
    "integer (int32)"
  ],
  "cards": [
    "string"
  ]
}

CardData: object

contentId: integer (int32)
cardDataItem: CardDataItem
CardDataItem
Example
{
  "contentId": "integer (int32)",
  "cardDataItem": [
    {
      "result": "object",
      "portletKey": "string"
    }
  ]
}

CardDataItem: object

result: object
portletKey: string
Example
{
  "result": "object",
  "portletKey": "string"
}

EditContentModel: object

title: string
body: string
culture: string
parentId: integer (int32)
isPublished: boolean
isArchived: boolean
pageType: string None, Page, Section, Link, ExternalLink, Bookmark, Calendar, PhotoGallery, NewsBlog, Forum, Group, Post, PostLink, ExternalPostLink, CalendarEvent, Document, Poll, MailingList, MailingListThread, MailingListThreadPost, Profile, Root, PollRoot, ProfileRoot, GroupsRoot, RssRoot, ForumTopic, Folder, Home, Search, MicroBlogEntry, Add, Edit, NotificationsHistory, ChangePassword, TermsConditions, Following, QuoteRoot, Invitation, ForgotPassword, UnfollowFromEmail, Activities, SharePointSearch, ShoutOut, EditProfileSettings, ShoutOutHistory, BulkUploaderToken, RssNewsBlog, RssExternalPostLink, Office365Search, GoogleDriveSearch, Form, FormEntry
linkUri: string
mailingListEmail: string
startDate: string
endDate: string
isAllDay: boolean
eventTypeId: integer (int32)
Example
{
  "title": "string",
  "body": "string",
  "culture": "string",
  "parentId": "integer (int32)",
  "isPublished": "boolean",
  "isArchived": "boolean",
  "pageType": "string",
  "linkUri": "string",
  "mailingListEmail": "string",
  "startDate": "string",
  "endDate": "string",
  "isAllDay": "boolean",
  "eventTypeId": "integer (int32)"
}

SaveEntityResponse[Content,CreateContentResult]: object

result: string Success, ValidationErrors, ParentNotFound, ContentTypeUnsupported, Unauthorized, Error
entity: Content
message: string
errors: string[]
string
Example
{
  "result": "string",
  "entity": {
    "body": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "contentId": "integer (int32)",
    "title": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "abbreviatedTitle": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "summary": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "dateModified": "string (date-time)",
    "datePosted": "string (date-time)",
    "datePublished": "string (date-time)",
    "modifiedId": "integer (int32)",
    "creatorId": "integer (int32)",
    "ownerId": "integer (int32)",
    "parentId": "integer (int32)",
    "grandParentId": "integer (int32)",
    "treePath": "string",
    "treePathItems": [
      {
        "contentId": "integer (int32)",
        "title": "string",
        "url": "string"
      }
    ],
    "treePathText": "string",
    "permissionIsEdit": "boolean",
    "permissionIsView": "boolean",
    "isPublished": "boolean",
    "isPrivate": "boolean",
    "isArchived": "boolean",
    "isUpdated": "boolean",
    "allowFiles": "boolean",
    "pageType": "string",
    "lastModifiedBy": "string"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

Content: object

body: KeyValuePair[String,String]
KeyValuePair[String,String]
contentId: integer (int32)
title: KeyValuePair[String,String]
KeyValuePair[String,String]
abbreviatedTitle: KeyValuePair[String,String]
KeyValuePair[String,String]
summary: KeyValuePair[String,String]
KeyValuePair[String,String]
dateModified: string (date-time)
datePosted: string (date-time)
datePublished: string (date-time)
modifiedId: integer (int32)
creatorId: integer (int32)
ownerId: integer (int32)
parentId: integer (int32)
grandParentId: integer (int32)
treePath: string
treePathItems: PageHierarchyItem
PageHierarchyItem
treePathText: string
permissionIsEdit: boolean
permissionIsView: boolean
isPublished: boolean
isPrivate: boolean
isArchived: boolean
isUpdated: boolean
allowFiles: boolean
pageType: string
lastModifiedBy: string
Example
{
  "body": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "creatorId": "integer (int32)",
  "ownerId": "integer (int32)",
  "parentId": "integer (int32)",
  "grandParentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean",
  "allowFiles": "boolean",
  "pageType": "string",
  "lastModifiedBy": "string"
}

SaveEntityResponse[Content,UpdateContentResult]: object

result: string Success, ValidationErrors, ContentNotFound, ContentTypeUnsupported, LockedForEditing, Unauthorized, Error
entity: Content
message: string
errors: string[]
string
Example
{
  "result": "string",
  "entity": {
    "body": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "contentId": "integer (int32)",
    "title": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "abbreviatedTitle": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "summary": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "dateModified": "string (date-time)",
    "datePosted": "string (date-time)",
    "datePublished": "string (date-time)",
    "modifiedId": "integer (int32)",
    "creatorId": "integer (int32)",
    "ownerId": "integer (int32)",
    "parentId": "integer (int32)",
    "grandParentId": "integer (int32)",
    "treePath": "string",
    "treePathItems": [
      {
        "contentId": "integer (int32)",
        "title": "string",
        "url": "string"
      }
    ],
    "treePathText": "string",
    "permissionIsEdit": "boolean",
    "permissionIsView": "boolean",
    "isPublished": "boolean",
    "isPrivate": "boolean",
    "isArchived": "boolean",
    "isUpdated": "boolean",
    "allowFiles": "boolean",
    "pageType": "string",
    "lastModifiedBy": "string"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

UserIdModel: object

userId: integer (int32)
Example
{
  "userId": "integer (int32)"
}

ContentTag: object

contentId: integer (int32)
tagId: integer (int32)
name: string
usage: integer (int32)
tagBundleId: integer (int32)
tagBundleLabel: string
Example
{
  "contentId": "integer (int32)",
  "tagId": "integer (int32)",
  "name": "string",
  "usage": "integer (int32)",
  "tagBundleId": "integer (int32)",
  "tagBundleLabel": "string"
}

SaveEntityResponse[IEnumerable[ContentTag],AddTagsResult]: object

result: string Success, ValidationErrors, PageNotFound, PageTaggingNotAllowed, Unauthorized, Error
entity: ContentTag
ContentTag
message: string
errors: string[]
string
Example
{
  "result": "string",
  "entity": [
    {
      "contentId": "integer (int32)",
      "tagId": "integer (int32)",
      "name": "string",
      "usage": "integer (int32)",
      "tagBundleId": "integer (int32)",
      "tagBundleLabel": "string"
    }
  ],
  "message": "string",
  "errors": [
    "string"
  ]
}

ActivityItemModel: object

userId: integer (int32)
contentId: integer (int32)
activityId: integer (int32)
activityType: string
message: string
dateCreated: string (date-time)
Example
{
  "userId": "integer (int32)",
  "contentId": "integer (int32)",
  "activityId": "integer (int32)",
  "activityType": "string",
  "message": "string",
  "dateCreated": "string (date-time)"
}

CustomPortletTemplate: object

portletTemplateId: integer (int32)
serverTemplate: string
clientTemplate: string
styleTemplate: string
isCurrent: boolean
Example
{
  "portletTemplateId": "integer (int32)",
  "serverTemplate": "string",
  "clientTemplate": "string",
  "styleTemplate": "string",
  "isCurrent": "boolean"
}

FollowingRequest: object

contentIds: integer[]
integer (int32)
userIds: integer[]
integer (int32)
Example
{
  "contentIds": [
    "integer (int32)"
  ],
  "userIds": [
    "integer (int32)"
  ]
}

User: object

userId: integer (int32)
contentId: integer (int32)
firstName: string
lastName: string
preferredName: string
salutation: string
email: string
username: string
jobTitle: string
timeZone: string
defaultCulture: string
birthday: string
birthdayDateTime: string
createdDate: string (date-time)
modifiedDate: string (date-time)
phoneNumbers: PhoneNumbers
images: UserImages
addressLine1: string
addressLine2: string
addressLine3: string
addressLine4: string
manager: SimpleUser
customFields: CustomField
CustomField
groups: SimpleGroup
SimpleGroup
isActive: boolean
Example
{
  "userId": "integer (int32)",
  "contentId": "integer (int32)",
  "firstName": "string",
  "lastName": "string",
  "preferredName": "string",
  "salutation": "string",
  "email": "string",
  "username": "string",
  "jobTitle": "string",
  "timeZone": "string",
  "defaultCulture": "string",
  "birthday": "string",
  "birthdayDateTime": "string",
  "createdDate": "string (date-time)",
  "modifiedDate": "string (date-time)",
  "phoneNumbers": {
    "fax": "string",
    "mobile": "string",
    "tel": "string"
  },
  "images": {
    "small": "string",
    "medium": "string",
    "large": "string"
  },
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string",
  "manager": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "fullName": "string",
    "imageUrl": "string",
    "url": "string",
    "isActive": "boolean"
  },
  "customFields": [
    {
      "customFieldId": "integer (int32)",
      "type": "string",
      "name": "string",
      "value": "object",
      "text": "string",
      "editable": "boolean",
      "label": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "groups": [
    {
      "name": "string",
      "contentId": "integer (int32)",
      "groupTypeId": "integer (int32)"
    }
  ],
  "isActive": "boolean"
}

PhoneNumbers: object

fax: string
mobile: string
tel: string
Example
{
  "fax": "string",
  "mobile": "string",
  "tel": "string"
}

UserImages: object

small: string
medium: string
large: string
Example
{
  "small": "string",
  "medium": "string",
  "large": "string"
}

SimpleUser: object

userId: integer (int32)
contentId: integer (int32)
fullName: string
imageUrl: string
url: string
isActive: boolean
Example
{
  "userId": "integer (int32)",
  "contentId": "integer (int32)",
  "fullName": "string",
  "imageUrl": "string",
  "url": "string",
  "isActive": "boolean"
}

CustomField: object

customFieldId: integer (int32)
type: string
name: string
value: object
text: string
editable: boolean
label: KeyValuePair[String,String]
KeyValuePair[String,String]
Example
{
  "customFieldId": "integer (int32)",
  "type": "string",
  "name": "string",
  "value": "object",
  "text": "string",
  "editable": "boolean",
  "label": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

SimpleGroup: object

name: string
contentId: integer (int32)
groupTypeId: integer (int32)
Example
{
  "name": "string",
  "contentId": "integer (int32)",
  "groupTypeId": "integer (int32)"
}

GroupAddUsersViewModel: object

added: User
User
failed: integer[]
integer (int32)
Example
{
  "added": [
    {
      "userId": "integer (int32)",
      "contentId": "integer (int32)",
      "firstName": "string",
      "lastName": "string",
      "preferredName": "string",
      "salutation": "string",
      "email": "string",
      "username": "string",
      "jobTitle": "string",
      "timeZone": "string",
      "defaultCulture": "string",
      "birthday": "string",
      "birthdayDateTime": "string",
      "createdDate": "string (date-time)",
      "modifiedDate": "string (date-time)",
      "phoneNumbers": {
        "fax": "string",
        "mobile": "string",
        "tel": "string"
      },
      "images": {
        "small": "string",
        "medium": "string",
        "large": "string"
      },
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "addressLine4": "string",
      "manager": {
        "userId": "integer (int32)",
        "contentId": "integer (int32)",
        "fullName": "string",
        "imageUrl": "string",
        "url": "string",
        "isActive": "boolean"
      },
      "customFields": [
        {
          "customFieldId": "integer (int32)",
          "type": "string",
          "name": "string",
          "value": "object",
          "text": "string",
          "editable": "boolean",
          "label": [
            {
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "groups": [
        {
          "name": "string",
          "contentId": "integer (int32)",
          "groupTypeId": "integer (int32)"
        }
      ],
      "isActive": "boolean"
    }
  ],
  "failed": [
    "integer (int32)"
  ]
}

GroupType: object

label: string
culture: string
groupTypeId: integer (int32)
sortOrder: integer (int32)
isPermanent: boolean
usingFallBackLabel: boolean
Example
{
  "label": "string",
  "culture": "string",
  "groupTypeId": "integer (int32)",
  "sortOrder": "integer (int32)",
  "isPermanent": "boolean",
  "usingFallBackLabel": "boolean"
}

AuthenticateRequest: object

username: string

The username of the user to authenticate

password: string

Required, if an Authorization header is not set. The password of the user to authenticate

authenticationToken: string

REST Api Token can be generated in admin panel, on the Api Token page

applicationId: string

A valid application id that allows the client to make calls against the API

impersonateUserId: integer (int32)

Id of User to Impersonate

Example
{
  "username": "string",
  "password": "string",
  "authenticationToken": "string",
  "applicationId": "string",
  "impersonateUserId": "integer (int32)"
}

CustomFieldItem: object

groupName: string
customFieldId: integer (int32)
customFieldName: string
type: string
editable: boolean
Example
{
  "groupName": "string",
  "customFieldId": "integer (int32)",
  "customFieldName": "string",
  "type": "string",
  "editable": "boolean"
}

Configuration: object

apiMustUseHttps: boolean
name: string
title: string
homeRecentActivityEnablePolling: boolean
homeRecentActivityPollingInterval: integer (int32)
desktopConnectorEnabled: boolean
uploadingSettings: UploadingSettings
version: string
Example
{
  "apiMustUseHttps": "boolean",
  "name": "string",
  "title": "string",
  "homeRecentActivityEnablePolling": "boolean",
  "homeRecentActivityPollingInterval": "integer (int32)",
  "desktopConnectorEnabled": "boolean",
  "uploadingSettings": {
    "blacklist": [
      "string"
    ],
    "whitelist": [
      "string"
    ]
  },
  "version": "string"
}

UploadingSettings: object

blacklist: string[]
string
whitelist: string[]
string
Example
{
  "blacklist": [
    "string"
  ],
  "whitelist": [
    "string"
  ]
}

NavigationChildrenOptions: object

depth: integer (int32)
contentIdsFilter: integer[]
integer (int32)
applyNavigationContentTypeFilter: boolean
includeArchivedContent: boolean
Example
{
  "depth": "integer (int32)",
  "contentIdsFilter": [
    "integer (int32)"
  ],
  "applyNavigationContentTypeFilter": "boolean",
  "includeArchivedContent": "boolean"
}

NewsFeedCreate: object

contentIds: integer[]
integer (int32)
groupTypeIds: integer[]
integer (int32)
pageSize: integer (int32)
startIndex: integer (int32)
showArchived: boolean
Example
{
  "contentIds": [
    "integer (int32)"
  ],
  "groupTypeIds": [
    "integer (int32)"
  ],
  "pageSize": "integer (int32)",
  "startIndex": "integer (int32)",
  "showArchived": "boolean"
}

SearchContentParameters: object

excludeContentIds: integer[]
integer (int32)
excludePageTypes: string[]
string None, Page, Section, Link, ExternalLink, Bookmark, Calendar, PhotoGallery, NewsBlog, Forum, Group, Post, PostLink, ExternalPostLink, CalendarEvent, Document, Poll, MailingList, MailingListThread, MailingListThreadPost, Profile, Root, PollRoot, ProfileRoot, GroupsRoot, RssRoot, ForumTopic, Folder, Home, Search, MicroBlogEntry, Add, Edit, NotificationsHistory, ChangePassword, TermsConditions, Following, QuoteRoot, Invitation, ForgotPassword, UnfollowFromEmail, Activities, SharePointSearch, ShoutOut, EditProfileSettings, ShoutOutHistory, BulkUploaderToken, RssNewsBlog, RssExternalPostLink, Office365Search, GoogleDriveSearch, Form, FormEntry
excludeTreePath: integer[]
integer (int32)
forArea: string General, Forum, Groups, People, NewsBlog, TitleOnly, PhotoGallery, BestBets, Polls, ShoutOuts, UserName, GroupTitle
forCulture: string
forEditedBy: integer[]
integer (int32)
forMentioned: integer[]
integer (int32)
forRequireAllUsersMentioned: boolean
forFirstLetterOfTitle: string
forOwnedBy: integer[]
integer (int32)
forPostedDate: string None, Last24Hours, Last7Days, Last30Days, Last3Months, Last6Months, LastYear, Over1Year
forPublishedDate: string None, Last24Hours, Last7Days, Last30Days, Last3Months, Last6Months, LastYear, Over1Year
forQuery: string
forSearchType: string None, Pages, Files, People, Groups, NewsBlog, Forums, Calendars, PhotoGalleries, Links, Polls, MailingLists, Comments, MicroBlogEntry, ShoutOut, Forms, Entries, EntryLists
forTags: integer[]
integer (int32)
includeArchived: boolean
includeInactiveUsers: boolean
includeComments: boolean
includePageTypes: string[]
string None, Page, Section, Link, ExternalLink, Bookmark, Calendar, PhotoGallery, NewsBlog, Forum, Group, Post, PostLink, ExternalPostLink, CalendarEvent, Document, Poll, MailingList, MailingListThread, MailingListThreadPost, Profile, Root, PollRoot, ProfileRoot, GroupsRoot, RssRoot, ForumTopic, Folder, Home, Search, MicroBlogEntry, Add, Edit, NotificationsHistory, ChangePassword, TermsConditions, Following, QuoteRoot, Invitation, ForgotPassword, UnfollowFromEmail, Activities, SharePointSearch, ShoutOut, EditProfileSettings, ShoutOutHistory, BulkUploaderToken, RssNewsBlog, RssExternalPostLink, Office365Search, GoogleDriveSearch, Form, FormEntry
sortType: string DateCreated, DateModified, DatePublished, LastName, Relevance, Title, IsImportant, TreePath, LastActiveDate, FirstName, Popularity, OwnerName, Votes, PageType, Mentioned, Label, Usage, BundleOrCustomField
sortDirection: string Ascending, Descending
pageSize: integer (int32)
pageNumber: integer (int32)
scope: integer (int32)
Example
{
  "excludeContentIds": [
    "integer (int32)"
  ],
  "excludePageTypes": [
    "string"
  ],
  "excludeTreePath": [
    "integer (int32)"
  ],
  "forArea": "string",
  "forCulture": "string",
  "forEditedBy": [
    "integer (int32)"
  ],
  "forMentioned": [
    "integer (int32)"
  ],
  "forRequireAllUsersMentioned": "boolean",
  "forFirstLetterOfTitle": "string",
  "forOwnedBy": [
    "integer (int32)"
  ],
  "forPostedDate": "string",
  "forPublishedDate": "string",
  "forQuery": "string",
  "forSearchType": "string",
  "forTags": [
    "integer (int32)"
  ],
  "includeArchived": "boolean",
  "includeInactiveUsers": "boolean",
  "includeComments": "boolean",
  "includePageTypes": [
    "string"
  ],
  "sortType": "string",
  "sortDirection": "string",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)",
  "scope": "integer (int32)"
}

SearchUserParameters: object

forQuery: string
forTags: integer[]
integer (int32)
forGroups: integer[]
integer (int32)
forFirstLetterOfLastName: string
forCustomFields: object
forCustomFieldDates: object
pageSize: integer (int32)
pageNumber: integer (int32)
sortType: string DateCreated, DateModified, DatePublished, LastName, Relevance, Title, IsImportant, TreePath, LastActiveDate, FirstName, Popularity, OwnerName, Votes, PageType, Mentioned, Label, Usage, BundleOrCustomField
sortDirection: string Ascending, Descending
Example
{
  "forQuery": "string",
  "forTags": [
    "integer (int32)"
  ],
  "forGroups": [
    "integer (int32)"
  ],
  "forFirstLetterOfLastName": "string",
  "forCustomFields": "object",
  "forCustomFieldDates": "object",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)",
  "sortType": "string",
  "sortDirection": "string"
}

SearchGroupParameters: object

forQuery: string
forTags: integer[]
integer (int32)
includeArchived: boolean
forFirstLetterOfTitle: string
forGroupTypes: integer[]
integer (int32)
forOwnedBy: integer[]
integer (int32)
forPublishedDate: string None, Last24Hours, Last7Days, Last30Days, Last3Months, Last6Months, LastYear, Over1Year
sortType: string DateCreated, DateModified, DatePublished, LastName, Relevance, Title, IsImportant, TreePath, LastActiveDate, FirstName, Popularity, OwnerName, Votes, PageType, Mentioned, Label, Usage, BundleOrCustomField
sortDirection: string Ascending, Descending
pageSize: integer (int32)
pageNumber: integer (int32)
Example
{
  "forQuery": "string",
  "forTags": [
    "integer (int32)"
  ],
  "includeArchived": "boolean",
  "forFirstLetterOfTitle": "string",
  "forGroupTypes": [
    "integer (int32)"
  ],
  "forOwnedBy": [
    "integer (int32)"
  ],
  "forPublishedDate": "string",
  "sortType": "string",
  "sortDirection": "string",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}

CreateSecurityGroup: object

name: string
Example
{
  "name": "string"
}

SecurityGroup: object

id: integer (int32)
sortOrder: integer (int32)
name: string
isPermanent: boolean
isEditable: boolean
lastSyncTime: string (date-time)
externalStoreGroupName: string
serviceUniqueIdentifier: string (uuid)
syncStatus: string None, Syncing, Failure, Success
userCount: integer (int32)
securingCount: integer (int32)
contentId: integer (int32)
securityGroupType: string System, Regular, ActiveDirectoryMapped, None
Example
{
  "id": "integer (int32)",
  "sortOrder": "integer (int32)",
  "name": "string",
  "isPermanent": "boolean",
  "isEditable": "boolean",
  "lastSyncTime": "string (date-time)",
  "externalStoreGroupName": "string",
  "serviceUniqueIdentifier": "string (uuid)",
  "syncStatus": "string",
  "userCount": "integer (int32)",
  "securingCount": "integer (int32)",
  "contentId": "integer (int32)",
  "securityGroupType": "string"
}

ItemsAndCount[SecurityGroup]: object

items: SecurityGroup
SecurityGroup
totalItems: integer (int32)
Example
{
  "items": [
    {
      "id": "integer (int32)",
      "sortOrder": "integer (int32)",
      "name": "string",
      "isPermanent": "boolean",
      "isEditable": "boolean",
      "lastSyncTime": "string (date-time)",
      "externalStoreGroupName": "string",
      "serviceUniqueIdentifier": "string (uuid)",
      "syncStatus": "string",
      "userCount": "integer (int32)",
      "securingCount": "integer (int32)",
      "contentId": "integer (int32)",
      "securityGroupType": "string"
    }
  ],
  "totalItems": "integer (int32)"
}

ItemsAndCount[User]: object

items: User
User
totalItems: integer (int32)
Example
{
  "items": [
    {
      "userId": "integer (int32)",
      "contentId": "integer (int32)",
      "firstName": "string",
      "lastName": "string",
      "preferredName": "string",
      "salutation": "string",
      "email": "string",
      "username": "string",
      "jobTitle": "string",
      "timeZone": "string",
      "defaultCulture": "string",
      "birthday": "string",
      "birthdayDateTime": "string",
      "createdDate": "string (date-time)",
      "modifiedDate": "string (date-time)",
      "phoneNumbers": {
        "fax": "string",
        "mobile": "string",
        "tel": "string"
      },
      "images": {
        "small": "string",
        "medium": "string",
        "large": "string"
      },
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "addressLine4": "string",
      "manager": {
        "userId": "integer (int32)",
        "contentId": "integer (int32)",
        "fullName": "string",
        "imageUrl": "string",
        "url": "string",
        "isActive": "boolean"
      },
      "customFields": [
        {
          "customFieldId": "integer (int32)",
          "type": "string",
          "name": "string",
          "value": "object",
          "text": "string",
          "editable": "boolean",
          "label": [
            {
              "key": "string",
              "value": "string"
            }
          ]
        }
      ],
      "groups": [
        {
          "name": "string",
          "contentId": "integer (int32)",
          "groupTypeId": "integer (int32)"
        }
      ],
      "isActive": "boolean"
    }
  ],
  "totalItems": "integer (int32)"
}

StaleContentQuery: object

numberOfTimesViewed: integer (int32)
lengthOfPeriod: integer (int32)
period: string Days, Months, Years
contentIdToSearchUnder: integer (int32)
excludedUserIds: integer[]
integer (int32)
sortOrder: string NumberOfViews, NumberOfSubPages, CreatedDate, LastViewedDate
sortDirection: string Ascending, Descending
query: string
selectedContentIds: integer[]
integer (int32)
includeArchived: boolean
pageNumber: integer (int32)
pageSize: integer (int32)
Example
{
  "numberOfTimesViewed": "integer (int32)",
  "lengthOfPeriod": "integer (int32)",
  "period": "string",
  "contentIdToSearchUnder": "integer (int32)",
  "excludedUserIds": [
    "integer (int32)"
  ],
  "sortOrder": "string",
  "sortDirection": "string",
  "query": "string",
  "selectedContentIds": [
    "integer (int32)"
  ],
  "includeArchived": "boolean",
  "pageNumber": "integer (int32)",
  "pageSize": "integer (int32)"
}

StaleContentChildrenQuery: object

numberOfTimesViewed: integer (int32)
lengthOfPeriod: integer (int32)
period: string Days, Months, Years
includeArchivedContent: boolean
pageNumber: integer (int32)
pageSize: integer (int32)
sortDirection: string Ascending, Descending
sortOrder: string NumberOfViews, NumberOfSubPages, CreatedDate, LastViewedDate
Example
{
  "numberOfTimesViewed": "integer (int32)",
  "lengthOfPeriod": "integer (int32)",
  "period": "string",
  "includeArchivedContent": "boolean",
  "pageNumber": "integer (int32)",
  "pageSize": "integer (int32)",
  "sortDirection": "string",
  "sortOrder": "string"
}

RequestIndexing: object

pageSize: integer (int32)
pageNumber: integer (int32)
Example
{
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}

ItemsAndCount[StatsContentAndCount]: object

items: StatsContentAndCount
StatsContentAndCount
totalItems: integer (int32)
Example
{
  "items": [
    {
      "content": {
        "contentId": "integer (int32)",
        "title": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "abbreviatedTitle": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "summary": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "dateModified": "string (date-time)",
        "datePosted": "string (date-time)",
        "datePublished": "string (date-time)",
        "modifiedId": "integer (int32)",
        "ownerId": "integer (int32)",
        "creatorId": "integer (int32)",
        "parentId": "integer (int32)",
        "treePath": "string",
        "treePathItems": [
          {
            "contentId": "integer (int32)",
            "title": "string",
            "url": "string"
          }
        ],
        "treePathText": "string",
        "permissionIsEdit": "boolean",
        "permissionIsView": "boolean",
        "isPublished": "boolean",
        "isPrivate": "boolean",
        "isArchived": "boolean",
        "isUpdated": "boolean"
      },
      "count": "integer (int32)"
    }
  ],
  "totalItems": "integer (int32)"
}

StatsContentAndCount: object

content: IContent
count: integer (int32)
Example
{
  "content": {
    "contentId": "integer (int32)",
    "title": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "abbreviatedTitle": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "summary": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "dateModified": "string (date-time)",
    "datePosted": "string (date-time)",
    "datePublished": "string (date-time)",
    "modifiedId": "integer (int32)",
    "ownerId": "integer (int32)",
    "creatorId": "integer (int32)",
    "parentId": "integer (int32)",
    "treePath": "string",
    "treePathItems": [
      {
        "contentId": "integer (int32)",
        "title": "string",
        "url": "string"
      }
    ],
    "treePathText": "string",
    "permissionIsEdit": "boolean",
    "permissionIsView": "boolean",
    "isPublished": "boolean",
    "isPrivate": "boolean",
    "isArchived": "boolean",
    "isUpdated": "boolean"
  },
  "count": "integer (int32)"
}

IContent: object

contentId: integer (int32)
title: KeyValuePair[String,String]
KeyValuePair[String,String]
abbreviatedTitle: KeyValuePair[String,String]
KeyValuePair[String,String]
summary: KeyValuePair[String,String]
KeyValuePair[String,String]
dateModified: string (date-time)
datePosted: string (date-time)
datePublished: string (date-time)
modifiedId: integer (int32)
ownerId: integer (int32)
creatorId: integer (int32)
parentId: integer (int32)
treePath: string
treePathItems: PageHierarchyItem
PageHierarchyItem
treePathText: string
permissionIsEdit: boolean
permissionIsView: boolean
isPublished: boolean
isPrivate: boolean
isArchived: boolean
isUpdated: boolean
Example
{
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "ownerId": "integer (int32)",
  "creatorId": "integer (int32)",
  "parentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean"
}

RequestOwnedPages: object

orderBy: string Title, CreatedDate, ModifiedDate, PublishedDate, PageType
sortDirection: string Ascending, Descending
pageSize: integer (int32)
pageNumber: integer (int32)
Example
{
  "orderBy": "string",
  "sortDirection": "string",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}

ItemsAndCount[IContent]: object

items: IContent
IContent
totalItems: integer (int32)
Example
{
  "items": [
    {
      "contentId": "integer (int32)",
      "title": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "abbreviatedTitle": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "summary": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "dateModified": "string (date-time)",
      "datePosted": "string (date-time)",
      "datePublished": "string (date-time)",
      "modifiedId": "integer (int32)",
      "ownerId": "integer (int32)",
      "creatorId": "integer (int32)",
      "parentId": "integer (int32)",
      "treePath": "string",
      "treePathItems": [
        {
          "contentId": "integer (int32)",
          "title": "string",
          "url": "string"
        }
      ],
      "treePathText": "string",
      "permissionIsEdit": "boolean",
      "permissionIsView": "boolean",
      "isPublished": "boolean",
      "isPrivate": "boolean",
      "isArchived": "boolean",
      "isUpdated": "boolean"
    }
  ],
  "totalItems": "integer (int32)"
}

StatsUserActionsRequest: object

userIds: integer[]
integer (int32)
groupIds: integer[]
integer (int32)
securityGroupIds: integer[]
integer (int32)
startDate: string (date-time)
endDate: string (date-time)
pageSize: integer (int32)
pageNumber: integer (int32)
Example
{
  "userIds": [
    "integer (int32)"
  ],
  "groupIds": [
    "integer (int32)"
  ],
  "securityGroupIds": [
    "integer (int32)"
  ],
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}

ItemsAndCount[StatsUserActions]: object

items: StatsUserActions
StatsUserActions
totalItems: integer (int32)
Example
{
  "items": [
    {
      "fullName": "string",
      "userId": "integer (int32)",
      "edits": "integer (int32)",
      "profileEdits": "integer (int32)",
      "creates": "integer (int32)",
      "searches": "integer (int32)",
      "comments": "integer (int32)",
      "likes": "integer (int32)",
      "bookmarks": "integer (int32)",
      "blogPosts": "integer (int32)",
      "forumPosts": "integer (int32)",
      "forumComments": "integer (int32)",
      "microBlogEntry": "integer (int32)",
      "attachments": "integer (int32)",
      "groupCount": "integer (int32)",
      "pollVotes": "integer (int32)",
      "follows": "integer (int32)",
      "mentions": "integer (int32)",
      "shoutOuts": "integer (int32)",
      "shoutOutsReceived": "integer (int32)",
      "profileCompletePercent": "number (float)"
    }
  ],
  "totalItems": "integer (int32)"
}

StatsUserActions: object

fullName: string
userId: integer (int32)
edits: integer (int32)
profileEdits: integer (int32)
creates: integer (int32)
searches: integer (int32)
comments: integer (int32)
likes: integer (int32)
bookmarks: integer (int32)
blogPosts: integer (int32)
forumPosts: integer (int32)
forumComments: integer (int32)
microBlogEntry: integer (int32)
attachments: integer (int32)
groupCount: integer (int32)
pollVotes: integer (int32)
follows: integer (int32)
mentions: integer (int32)
shoutOuts: integer (int32)
shoutOutsReceived: integer (int32)
profileCompletePercent: number (float)
Example
{
  "fullName": "string",
  "userId": "integer (int32)",
  "edits": "integer (int32)",
  "profileEdits": "integer (int32)",
  "creates": "integer (int32)",
  "searches": "integer (int32)",
  "comments": "integer (int32)",
  "likes": "integer (int32)",
  "bookmarks": "integer (int32)",
  "blogPosts": "integer (int32)",
  "forumPosts": "integer (int32)",
  "forumComments": "integer (int32)",
  "microBlogEntry": "integer (int32)",
  "attachments": "integer (int32)",
  "groupCount": "integer (int32)",
  "pollVotes": "integer (int32)",
  "follows": "integer (int32)",
  "mentions": "integer (int32)",
  "shoutOuts": "integer (int32)",
  "shoutOutsReceived": "integer (int32)",
  "profileCompletePercent": "number (float)"
}

RequestIndexStartEndDate: object

startDate: string (date-time)
endDate: string (date-time)
pageSize: integer (int32)
pageNumber: integer (int32)
Example
{
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}

StatsPageReportRequest: object

ownedByUserIds: integer[]
integer (int32)
pageTypes: string[]
string None, Page, Section, Link, ExternalLink, Bookmark, Calendar, PhotoGallery, NewsBlog, Forum, Group, Post, PostLink, ExternalPostLink, CalendarEvent, Document, Poll, MailingList, MailingListThread, MailingListThreadPost, Profile, Root, PollRoot, ProfileRoot, GroupsRoot, RssRoot, ForumTopic, Folder, Home, Search, MicroBlogEntry, Add, Edit, NotificationsHistory, ChangePassword, TermsConditions, Following, QuoteRoot, Invitation, ForgotPassword, UnfollowFromEmail, Activities, SharePointSearch, ShoutOut, EditProfileSettings, ShoutOutHistory, BulkUploaderToken, RssNewsBlog, RssExternalPostLink, Office365Search, GoogleDriveSearch, Form, FormEntry
sectionIds: integer[]
integer (int32)
contentIds: integer[]
integer (int32)
userIds: integer[]
integer (int32)
startDate: string (date-time)
endDate: string (date-time)
pageSize: integer (int32)
pageNumber: integer (int32)
Example
{
  "ownedByUserIds": [
    "integer (int32)"
  ],
  "pageTypes": [
    "string"
  ],
  "sectionIds": [
    "integer (int32)"
  ],
  "contentIds": [
    "integer (int32)"
  ],
  "userIds": [
    "integer (int32)"
  ],
  "startDate": "string (date-time)",
  "endDate": "string (date-time)",
  "pageSize": "integer (int32)",
  "pageNumber": "integer (int32)"
}

ItemsAndCount[StatsPageActions]: object

items: StatsPageActions
StatsPageActions
totalItems: integer (int32)
Example
{
  "items": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "views": "integer (int32)",
      "uniqueViews": "integer (int32)",
      "creates": "integer (int32)",
      "edits": "integer (int32)",
      "downloads": "integer (int32)",
      "uniqueDownloads": "integer (int32)",
      "likes": "integer (int32)",
      "follows": "integer (int32)",
      "comments": "integer (int32)",
      "bookmarks": "integer (int32)",
      "shares": "integer (int32)",
      "lastViewed": "string (date-time)",
      "lastDownloaded": "string (date-time)",
      "modifiedDate": "string (date-time)",
      "isArchived": "boolean",
      "isPublished": "boolean"
    }
  ],
  "totalItems": "integer (int32)"
}

StatsPageActions: object

contentId: integer (int32)
title: string
views: integer (int32)
uniqueViews: integer (int32)
creates: integer (int32)
edits: integer (int32)
downloads: integer (int32)
uniqueDownloads: integer (int32)
likes: integer (int32)
follows: integer (int32)
comments: integer (int32)
bookmarks: integer (int32)
shares: integer (int32)
lastViewed: string (date-time)
lastDownloaded: string (date-time)
modifiedDate: string (date-time)
isArchived: boolean
isPublished: boolean
Example
{
  "contentId": "integer (int32)",
  "title": "string",
  "views": "integer (int32)",
  "uniqueViews": "integer (int32)",
  "creates": "integer (int32)",
  "edits": "integer (int32)",
  "downloads": "integer (int32)",
  "uniqueDownloads": "integer (int32)",
  "likes": "integer (int32)",
  "follows": "integer (int32)",
  "comments": "integer (int32)",
  "bookmarks": "integer (int32)",
  "shares": "integer (int32)",
  "lastViewed": "string (date-time)",
  "lastDownloaded": "string (date-time)",
  "modifiedDate": "string (date-time)",
  "isArchived": "boolean",
  "isPublished": "boolean"
}

CreateUserModel: object

firstName: string
lastName: string
email: string
username: string
userServiceUniqueIdentifier: string
authenticationStore: string None, ActiveDirectory, WindowsLocal, Database, OpenLdap, External
Example
{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "username": "string",
  "userServiceUniqueIdentifier": "string",
  "authenticationStore": "string"
}

SaveEntityResponse[User,CreateUserResult]: object

result: string Success, Unauthorized, ValidationErrors, DuplicateUser, Error
entity: User
message: string
errors: string[]
string
Example
{
  "result": "string",
  "entity": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "firstName": "string",
    "lastName": "string",
    "preferredName": "string",
    "salutation": "string",
    "email": "string",
    "username": "string",
    "jobTitle": "string",
    "timeZone": "string",
    "defaultCulture": "string",
    "birthday": "string",
    "birthdayDateTime": "string",
    "createdDate": "string (date-time)",
    "modifiedDate": "string (date-time)",
    "phoneNumbers": {
      "fax": "string",
      "mobile": "string",
      "tel": "string"
    },
    "images": {
      "small": "string",
      "medium": "string",
      "large": "string"
    },
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressLine4": "string",
    "manager": {
      "userId": "integer (int32)",
      "contentId": "integer (int32)",
      "fullName": "string",
      "imageUrl": "string",
      "url": "string",
      "isActive": "boolean"
    },
    "customFields": [
      {
        "customFieldId": "integer (int32)",
        "type": "string",
        "name": "string",
        "value": "object",
        "text": "string",
        "editable": "boolean",
        "label": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    ],
    "groups": [
      {
        "name": "string",
        "contentId": "integer (int32)",
        "groupTypeId": "integer (int32)"
      }
    ],
    "isActive": "boolean"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

EditUserModel: object

firstName: string
lastName: string
email: string
salutation: string
preferredName: string
profileText: string
jobTitle: string
phoneTel: string
phoneMobile: string
phoneFax: string
timeZone: string
defaultCulture: string
birthday: string (date-time)
birthdayDisplay: string None, ShowFull, ShowMonthAndDay, Hide
addressLine1: string
addressLine2: string
addressLine3: string
addressLine4: string
Example
{
  "firstName": "string",
  "lastName": "string",
  "email": "string",
  "salutation": "string",
  "preferredName": "string",
  "profileText": "string",
  "jobTitle": "string",
  "phoneTel": "string",
  "phoneMobile": "string",
  "phoneFax": "string",
  "timeZone": "string",
  "defaultCulture": "string",
  "birthday": "string (date-time)",
  "birthdayDisplay": "string",
  "addressLine1": "string",
  "addressLine2": "string",
  "addressLine3": "string",
  "addressLine4": "string"
}

SaveEntityResponse[User,UpdateUserResult]: object

result: string Success, UserNotFound, Unauthorized, ValidationErrors, DuplicateUser, Error
entity: User
message: string
errors: string[]
string
Example
{
  "result": "string",
  "entity": {
    "userId": "integer (int32)",
    "contentId": "integer (int32)",
    "firstName": "string",
    "lastName": "string",
    "preferredName": "string",
    "salutation": "string",
    "email": "string",
    "username": "string",
    "jobTitle": "string",
    "timeZone": "string",
    "defaultCulture": "string",
    "birthday": "string",
    "birthdayDateTime": "string",
    "createdDate": "string (date-time)",
    "modifiedDate": "string (date-time)",
    "phoneNumbers": {
      "fax": "string",
      "mobile": "string",
      "tel": "string"
    },
    "images": {
      "small": "string",
      "medium": "string",
      "large": "string"
    },
    "addressLine1": "string",
    "addressLine2": "string",
    "addressLine3": "string",
    "addressLine4": "string",
    "manager": {
      "userId": "integer (int32)",
      "contentId": "integer (int32)",
      "fullName": "string",
      "imageUrl": "string",
      "url": "string",
      "isActive": "boolean"
    },
    "customFields": [
      {
        "customFieldId": "integer (int32)",
        "type": "string",
        "name": "string",
        "value": "object",
        "text": "string",
        "editable": "boolean",
        "label": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    ],
    "groups": [
      {
        "name": "string",
        "contentId": "integer (int32)",
        "groupTypeId": "integer (int32)"
      }
    ],
    "isActive": "boolean"
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

Detail: object

body: KeyValuePair[String,String]
KeyValuePair[String,String]
contentId: integer (int32)
title: KeyValuePair[String,String]
KeyValuePair[String,String]
abbreviatedTitle: KeyValuePair[String,String]
KeyValuePair[String,String]
summary: KeyValuePair[String,String]
KeyValuePair[String,String]
dateModified: string (date-time)
datePosted: string (date-time)
datePublished: string (date-time)
modifiedId: integer (int32)
creatorId: integer (int32)
ownerId: integer (int32)
parentId: integer (int32)
grandParentId: integer (int32)
treePath: string
treePathItems: PageHierarchyItem
PageHierarchyItem
treePathText: string
permissionIsEdit: boolean
permissionIsView: boolean
isPublished: boolean
isPrivate: boolean
isArchived: boolean
isUpdated: boolean
allowFiles: boolean
pageType: string
lastModifiedBy: string
Example
{
  "body": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "contentId": "integer (int32)",
  "title": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "abbreviatedTitle": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "summary": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "dateModified": "string (date-time)",
  "datePosted": "string (date-time)",
  "datePublished": "string (date-time)",
  "modifiedId": "integer (int32)",
  "creatorId": "integer (int32)",
  "ownerId": "integer (int32)",
  "parentId": "integer (int32)",
  "grandParentId": "integer (int32)",
  "treePath": "string",
  "treePathItems": [
    {
      "contentId": "integer (int32)",
      "title": "string",
      "url": "string"
    }
  ],
  "treePathText": "string",
  "permissionIsEdit": "boolean",
  "permissionIsView": "boolean",
  "isPublished": "boolean",
  "isPrivate": "boolean",
  "isArchived": "boolean",
  "isUpdated": "boolean",
  "allowFiles": "boolean",
  "pageType": "string",
  "lastModifiedBy": "string"
}

SaveEntityResponse[CustomField,UpdateCustomFieldResult]: object

result: string Success, Unauthorized, UserNotFound, CustomFieldNotFound, ValidationErrors, Error
entity: CustomField
message: string
errors: string[]
string
Example
{
  "result": "string",
  "entity": {
    "customFieldId": "integer (int32)",
    "type": "string",
    "name": "string",
    "value": "object",
    "text": "string",
    "editable": "boolean",
    "label": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "message": "string",
  "errors": [
    "string"
  ]
}

UpdateCustomFieldTagModel: object

value: string
Example
{
  "value": "string"
}

UpdateStatusModel: object

userId: integer (int32)
isActive: boolean
Example
{
  "userId": "integer (int32)",
  "isActive": "boolean"
}