This documentation supports the 22.1 version of BMC Helix Digital Workplace Basic and BMC Helix Digital Workplace Advanced. Icons distinguish capabilities available only for the Advanced and External license levels. For more information, see License-types-and-features.

Endpoints in REST API


API documentation for BMC Helix Digital Workplace and BMC Helix Digital Workplace Catalog. The base URL for the API is:

https://serverName:portNumber/api/myit-sb

day2Actions

{{status subtle="false" colour="Blue" title="GET"/}}

 /day2Actions/revisions/all
Click here to expand...
Description

Retrieves all Day 2 action revision records for associated services or asset groups. Note that you can ONLY access this endpoint if you have Catalog administrator or equivalent system privileges. <br><br>Offset-based pagination is used to present the result set. If no *perPage* value is provided, by default 20 records will be returned per GET call, starting with the first page of the result set corresponding to your query. To retrieve the remaining records, make additional GET calls indicating the *page* value until the end of the result set is reached. For example: /day2Actions/revisions/all?page=2&perPage=40. <br><br>Additionally note that *state* (which specifies service states) and *categoryId* (specifies asset categories) are multi-value parameters, which means that you can pass more than one value for them using the same paramater. For example: /day2Actions/revisions/all?state=DRAFT&state=PENDING.

Parameters

Name

Located in

Description

Default

Schema

perPage

query

The number of records to return per page

20

integer

page

query

The page order in the result set for the current GET call

1

integer

sortBy

query

The field to sort the result set by, as per the *sortDirection*. If no value is provided, records will be sorted by their last modification date, starting with the most recent one

"modifiedDate"

string

sortDirection

query

The sort order for the result set. Allowed values are asc for ascending, and desc for descending

"desc"

string
Enum: [
 "ASC",
 "DESC"
]

state

query

A multi-value parameter which lets you filter the result set by one or more service state values. Allowed values are DRAFT, PENDING, PUBLISHED, APPROVED, DECLINED, and DELETED. Note that this is a multi-value paramater


[
 string
]

categoryId

query

A multi-value parameter which lets you filter the result set by one or more asset category IDs, such as 123


[
 string
]

workflowId

query

Lets you filter the result set by a specific workflow GUID, such as rx-a3b3b0b3-ef69-4ee7-b8e6-af9e295cde70


string

search

query

Lets you filter the result set by a Day 2 revision name (which can be any string value)


string

available

query

Indicates if only Day 2 revisions that are available for the current user should be returned or not


boolean

Responses

Code

Description

Schema

200

Day 2 action revisions successfully retrieved.


mystuffs

My Stuff items

{{status subtle="false" colour="Blue" title="GET"/}}

 /mystuffs/categories
Click here to expand...
Description

Returns all non-empty items from a user's My Stuff asset categories. If a specific user ID is not supplied (via the *requestedfor* paramater), the caller's login ID will be used.

Parameters

Name

Located in

Description

Default

Schema

requestedfor

query

The login ID of the intended user

"The login ID of current user or API caller"

string

itemsPerCategory

query

The number of items to return per category

16

integer

Responses

Code

Description

Schema

200

My Stuff items retrieved successfully.

{{status subtle="false" colour="Blue" title="GET"/}}

 /mystuffs/{myStuffItemId}/actions
Click here to expand...
Description

Returns Day 2 actions that are available for a specific My Stuff item identified by *{myStuffItemId}*.

Parameters

Name

Located in

Description

Default

Schema

myStuffItemId

path

The Base64-encoded My Stuff item ID


string*

Responses

Code

Description

Schema

200

Day 2 Actions for the item were retrieved successfully.


orders

Bulk service request orders

{{status subtle="false" colour="Green" title="POST"/}}

 /orders
Click here to expand...
Description

Lets you create a bulk order for a number of related service requests (which you have already created using the */requests* endpoint).

Parameters

Name

Located in

Description

Default

Schema

body

body

Service order


Responses

Code

Description

Schema

201

Order created successfully.



requests

Bulk service requests for an order

{{status subtle="false" colour="Green" title="POST"/}}

 /requests
Click here to expand...
Description

Lets you create service requests for a bulk order (see */orders). For example, you can request a new laptop for ten employees who have provided identical answers to the service request questions. A unique **requestId* value will be generated for each user, which can then be included in a POST /orders call to associate all the requests with a single order. <br><br>If it is related to a Day 2 action, the requested service will be surfaced in the users' My Stuff page in BMC Digital Workplace (provided a *MyStuffItemId* is included in the request). You can also request a service on behalf of another user by providing the user ID as the *onBehalfOfUserId* value.

Parameters

Name

Located in

Description

Default

Schema

body

body

Creates a service request creation object.


Responses

Code

Description

Schema

201

Service requests created successfully.

{{status subtle="false" colour="Blue" title="GET"/}}

 /requests/{id}/questionnaire
Click here to expand...
Description

Retrieves a questionnaire for a specific service request.

Parameters

Name

Located in

Description

Default

Schema

id

path

The service request ID for a new request


string*

prefillRequestIds

query

A list of completed service request IDs to search for saved answers while re-requesting a service


string

Responses

Code

Description

Schema

200

Questionnaire retrieved successfully.


services

{{status subtle="false" colour="Green" title="POST"/}}

 /services/searches
Click here to expand...
Description

Lets you search for existing services. If the pagination and sorting parameters are left at default values, each page in the result set will contain 20 records, and will be ordered by the last modified record. <br><br>Offset-based pagination is used to present the result set. If no perPage value is provided, by default 20 records will be returned per GET call, starting with the first page of the result set corresponding to your query. To retrieve the remaining records, make additional GET calls indicating the page value until the end of the result set is reached. For example: /services/searches?page=2&perPage=40.

Parameters

Name

Located in

Description

Default

Schema

perPage

query

The number of service records to return per page for the result set

20

integer

page

query

The page order in the result set for this call

1

integer

sortBy

query

The field to sort the result set by

"modifiedDate"

string
Enum: [
 "name",
 "templateName",
 "modifiedDate",
 "subCatalogName"
]

sortDirection

query

The sort direction for the result set (ascending or descending values of *sortBy*)

"desc"

string
Enum: [
 "asc",
 "desc"
]

X-DWP-SubCatalog

header

A custom header identifying the sub-catalog on an external system, such as BMC Helix Business Workflows

""

string

Responses

Code

Description

Schema

200

Services retrieved successfully.

{{status subtle="false" colour="Blue" title="GET"/}}

 /services/{id}/day2Actions
Click here to expand...
Description

Gets Day 2 actions for a service identified by *{id}*. <br><br>Offset-based pagination is used to present the result set. If no perPage value is provided, by default 20 records will be returned per GET call, starting with the first page of the result set corresponding to your query. To retrieve the remaining records, make additional GET calls indicating the page value until the end of the result set is reached. For example: /services/{id}/day2Actions?page=2&perPage=40.

Parameters

Name

Located in

Description

Default

Schema

id

path

The service version ID


string*

perPage

query

The number of records to return per page. The default value (-1) indicates that all records matching the query will be returned

-1

integer

page

query

The page order in the result set for the current GET call

1

integer

sortDirection

query

The sort order for the result set. Allowed values are asc for ascending, and desc for descending. The default sort field is *id*

"asc"

string
Enum: [
 "ASC",
 "DESC"
]

q

query

The service state to filter the result set by. Allowed values are DRAFT, PENDING, PUBLISHED, APPROVED, DECLINED, and DELETED


string

Responses

Code

Description

Schema

200

Day 2 actions retrieved successfully.

{{status subtle="false" colour="Green" title="POST"/}}

 /services/{id}/day2Actions
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

id

path

Service version id


string*

body

body

Version IDs of Day 2 Action to which the Service will be assigned to


[
 string
]

Responses

Code

Description

Schema

200

successful

{{status subtle="false" colour="Yellow" title="PUT"/}}

 /services/{id}/day2Actions
Click here to expand...
Description

Lets you update Day 2 actions for a specific service.

Parameters

Name

Located in

Description

Default

Schema

id

path

The service version ID associated with the Day 2 actions


string*

body

body

A list of version IDs of Day 2 Actions


[
 string
]

Responses

Code

Description

Schema

200

Day 2 actions updated successfully.

{{status subtle="false" colour="Red" title="DELETE"/}}

 /services/{id}/day2Actions
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

id

path

Service version id


string*

body

body

Version IDs of Day 2 Action from which the Service will be unassigned from


[
 string
]

Responses

Code

Description

Schema

200

successful

{{status subtle="false" colour="Green" title="POST"/}}

 /services/{serviceversionId}/questionnaire/answers
Click here to expand...
Description

Creates one or more answers for a question included in a service questionnaire. You must provide at least one answer for a question specified by its *questionId*.

Parameters

Name

Located in

Description

Default

Schema

serviceversionId

path

The service revision ID used to identify the service


string*

body

body

Eligible answers for a question that is part of the questionnaire


Responses

Code

Description

Schema

200

successful operation

{
}

201

Answers created successfully.

{{status subtle="false" colour="Blue" title="GET"/}}

 /services/{serviceversionId}/versions
Click here to expand...
Description

Retrieves existing versions of a service specified by the service ID.

Parameters

Name

Located in

Description

Default

Schema

serviceversionId

path

The service ID


string*

Responses

Code

Description

Schema

200

Service versions retrieved successfully.

{{status subtle="false" colour="Green" title="POST"/}}

 /services/{serviceversionId}/versions
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

serviceversionsId

path

Service id


string*

body

body

Core service version DTO


#CoreServiceVersionDTO

Responses

Code

Description

Schema

200

successful operation

201

successful



locations

post  /search
Returns all locations.
Description

Returns all locations that are available to the 

BMC Helix Digital Workplace

 user (without floor maps and other information).

Parameters

Name

Required/Optional

Description

Type

id

Required

ID of the location.

String

name

Required

Location name.

String

address

Required

Location address.

String

desc

Optional

Location description.

String

phone

Optional

Phone number of the location.

String

createDate

Required

Date of the location creation.

String

modifiedDate

Optional

Last modified date of the location.

String

siteName

Required (if Type is Corporate)

Name of the site.

String

type

Required

Location type.

Integer

longitude

Optional

Location longitude.

Decimal (8 places)

latitude

Optional

Location latitude.

Decimal (8 places)

externalId

Optional

External ID of the location.

String

timeZone

Required

Timezone of the location.

String

deleted

Optional

Date of the floor map deleting.

Selection

distance (calculate on fly, in miles)

Optional

Distance to the location.

Decimal

Request body
{ "queryName":"MYIT_ALL_LOCATIONS_ONLY", "attributes":{"Location":[<attributeName>,...]} }
Response body
[ { "dataSourceName":"Location", "syncTime":<long>, "numMatch":<long>, "items":[{<attributeName>:<attributeValue>,...},...] } ]

POST /v2/location
Creates a location.

Creates a location.

Response body
{"id": "string",

"createDate": "2020-07-03T14:38:47Z",

"modifiedDate": "2020-07-03T14:38:47Z",

"tenantId": "string",

"address": "string",

"desc": "string",

"externalId": "string",

"latitude": 0,

"longitude": 0,

"name": "string",

"phone": "string",

"siteName": "string",

"timeZone": "string",

"type": 0,

"distance": 0,

"floorMapCount": 0,

"thumbnail": "string",

"thumbnailMime": "string",

"floorMaps":
[
{}
]
}

floor maps

Floor map parameters.
Parameters

Name

Required/Optional

Description

Type

id

Required

ID of the floor map.

String

name

Required

Floor map name.

String

desc

Optional

Floor map description.

String

floorOrder

Required

Order ID of the floor map.

Integer

locationId (FK)

Required

Location ID of the floor map.

String

createDate

Required

Date of the floor map creation.

String

modifiedDate

Optional

Last modified date of the floor map.

String

deleted

Optional

Date of the floor map deleting.

Selection


floor map assets

GET /rest/search
Returns individual floor map assets.

The following example returns individual floor map assets by external ID.

Parameters
Name
Required/Optional
Description
Type
Notes

id

Required

ID of the floor map asset.

String

Not applicable.

floorMapId

Required

ID of the floor map.

String

If the asset is not assigned to a floor map, the ID is -1 . The ID is used when importing assets.

name

Required

Name of the floor map asset.

String

Not applicable.

assetStatus

Required

Status of the floor map asset.

Selection

The values are:0: Neutral
1: Good
2: Bad

assetTypeId

Required

ID of the floor map asset type.

String

Default -1.

locationDesc

Optional

Description of the floor map asset location.

String

Not applicable.

desc

Optional

Description of the floor map asset.

String

Not applicable.

desc2

Optional

Description of the floor map asset 2.

String

Not applicable.

desc3

Optional

Description of the floor map asset 3.

String

Not applicable.

xPos

Required

xPos

Number

Default 0.

yPos

Required

yPos

Number

Default 0.

createDate

Required

Date of the floor map asset creation.

String

Not applicable.

modifiedDate

Optional

Last modified date of the floor map asset creation.

String

Not applicable.

metaData

Optional

Metadata of the floor map asset.

String

The array of the key-value pairs with a semicolon delimiter.

phone

Optional

The phone number for the asset. It can be contact information or a conference room number.

String

Not applicable.

parentId

Optional

Parent asset ID.

String

Default -1.

tag

Optional

Custom tag to narrow down available actions.

String

Not applicable.

externalId

Optional

External ID of the floor map asset.

String

Not applicable.

locationId

Required

It is used during an asset import where you can specify the location into which to import assets. Then, on that location’s floor maps, you can see unused assets only for that location.

String

If not assigned, default -1.

qrCodeData

Optional

Data that can later be printed out as a QR code.

String

Not applicable.

deleted

Optional

Date of the floor map asset deleting.

Selection

Not applicable.

Request body
{ "queryName": "MYIT_FLOOR_MAP_ASSET_BY_EXTERNAL_ID", "attributes": {"ExternalLocationFloorMapAsset": [ "id", "externalId", "name", "desc", "assetStatus", "getTime" ]}, "queryParameters": [{ "name": "externalId", "value": _External ID of the floor map asset to update_ }] }
Response body
{ "items": [{ "id": _MyIT ID of the floor map asset which was just updated_, “externalId”: _External ID of the floor map asset_, “name”: _Name of the asset_, "desc": _Description of the asset,_ "assetStatus": _Status of the asset: 0 for Neutral, 1 for Good (Available), 2 for Bad (Unavailable)_ "getTime": 1362049473 }], "numMatch": _Number of items returned (normally only 1 for this query)_, "syncTime": _Last time a synchronization was done_, "dataSourceName": "ExternalLocationFloorMapAsset" }]
PUT /rest/update
Updates the floor map assets.

Updates the floor map assets.

Request body
{"LocationFloorMapAsset": {
 "id": ID of the floor map asset to update,
 "previousVersion": {},
 "changes": {
   "desc": New description of the asset (when reserving, use the old description appended with reserver of the asset),
   "assetStatus": New status of the asset:  0 for Neutral, 1 for Good (Available), 2 for Bad (Unavailable)
  }
}}
Response body
{
 "desc": Newly assigned description of the asset,
 "assetStatus": Newly assigned status of the asset:  0 for Neutral, 1 for Good (Available), 2 for Bad (Unavailable),
 "getTime": 1361500082
}
PUT /rest/update
Updates the floor map assets by the BMC Digital Workplace ID.

Updates the floor map assets by the BMC Helix Digital WorkplaceID.

Request body
{"ExternalLocationFloorMapAsset": {

 "id": _External ID of the floor map asset to update_,

 "previousVersion": {},

 "changes": {

    “externalId”: _New external ID of the floor map asset_,

    “name”: _The new name of the asset_,

   "desc": _New description of the asset (when reserving an asset, use the old description appended with reserver of the asset),_

   "assetStatus": _New status of the asset:  0 for Neutral, 1 for Good (Available), 2 for Bad (Unavailable)_

  }

}}
Response body
{

 "id": _MyIT ID of the floor map asset which was just updated_,

  “externalId”: _Newly assigned external ID of the floor map asset_,

  “name”: _Newly assigned name of the asset_,

 "desc": _Newly assigned description of the asset_,

 "assetStatus": _Newly assigned status of the asset:  0 for Neutral, 1 for Good (Available), 2 for Bad (Unavailable)_,

 "getTime": 1361500082

}
PUT /rest/update
Updates the floor map assets by the external ID.

Updates the floor map assets by the external ID.

Request body
{"ExternalLocationFloorMapAsset": {

 "id": _External ID of the floor map asset to update_,

 "previousVersion": {},

 "changes": {

    “externalId”: _New external ID of the floor map asset_,

    “name”: _The new name of the asset_,

   "desc": _New description of the asset (when reserving an asset, use the old description appended with reserver of the asset),_

   "assetStatus": _New status of the asset:  0 for Neutral, 1 for Good (Available), 2 for Bad (Unavailable)_

  }

}}
Response body
{

 "id": _MyIT ID of the floor map asset which was just updated_,

  “externalId”: _Newly assigned external ID of the floor map asset_,

  “name”: _Newly assigned name of the asset_,

 "desc": _Newly assigned description of the asset_,

 "assetStatus": _Newly assigned status of the asset:  0 for Neutral, 1 for Good (Available), 2 for Bad (Unavailable)_,

 "getTime": 1361500082

}

location floor map images

Floor map image parameters.
Parameters

Name

Required/Optional

Description

Type

Notes

id

Required

ID of the floor map image.

String

Not applicable.

floorMapId

Required

ID of the floor map image.

String

If the image is not assigned to a floor map, the ID -1.

image

Required

Image attached to the floor map.

Attachment Pool

Not applicable.

createDate

Required

Date of the floor map image creation.

Date

Not applicable.

modifiedDate

Optional

Last modified date of the floor map image.

Date

Not applicable.

entryId

Optional

Entry ID of the floor map image.

String

Not applicable.


floor map asset actions

Floor map asset action parameters.
Parameters

Name

Required/Optional

Description

Type

id

Required

ID of the floor map asset action.

String

name

Required

Name of the floor map asset action.

String

actionType

Required

Type of the floor map asset action.

Selection (Client URLServer URLDefault SRDSRD)

actionValue

Optional

Value of the floor map asset action type.

String

createDate

Optional

Date of the floor map asset action creation.

Date

modifiedDate

Optional

Last modified date of the floor map image.

Date

tag

Optional

Tag of the floor map asset action.

String



floor map asset types

Floor map asset type parameters.
Parameters

Name

Required/Optional

Description

Type

id

Required

ID of the floor asset type.

String

name

Required

Name of the floor asset type.

String

alias

Required

Used for icon mapping because you can edit ID and Name.

String

desc

Optional

Description of the floor map asset type.

String

goodStatusLabel

Required

Good status label.

String

badStatusLabel

Required

Bad status label.

String

createDate

Required

Date of the floor map asset action creation.

Date

modifiedDate

Optional

Last modified date of the floor map image.

Date

actions

Required

List of action IDs with a semicolon delimiter (for example, actionId1; actionId2)

String


service availability

POST /search
Returns all services.

Returns all the services.

Parameters

Name

Required/Optional

Description

Type

id

Required

ID of the service.

String

linkedServiceversionId

Optional

ID of the linked service.

String

linkedServiceName

Optional

The BMC Helix Digital Workplace Admin Console needs this attribute to display a user-friendly name that the external system uses.

String

name

Required

Name of the service.

String

desc

Optional

Description of the service.

String

iconId

Optional

ID of the service icon.

String

annotation

Optional

Annotation of the service.

String

status

Required

Status of the service.

Integer

isEnabled

Optional

Integer in Java.

Selection

isAutoSubscribe

Optional

Integer in Java.

Selection

statusIsManual

Optional

Integer in Java.

Selection

accessGroups

Optional

On the server, you will build a string where the groups are separated by semicolons.  AR System knows how to interpret that string as a list.

Array of strings

lastNotifiedStatus

Optional

Last modified status.

Selection

lastNotifiedStatusTime

Optional

Time of the last modified status.

Integer

createDate

Required

Date of the service creation.

Date

modifiedDate

Optional

Last modified date of the floor map image.

Date

Request body

{
  "queryName":"MYIT_ALL_SERVICES",
  "attributes":{"Service":[<attributeName>,...]}
}

Response body

[
  {
    "dataSourceName":"Service",
    "syncTime":<long>, // the time the search was executed in seconds since 01/01/1970
    "numMatch":<long>,
    "items":[{<attributeName>:<attributeValue>,...},...]
  }
]

post  /search
Creates a service ID and its create date.

Creates a service ID and its create date (getTime field) and returns them into the response body.

Note

Convert the list of strings (accessGroups parameter) into a semicolon-separated list.


Request body

{
  {<attributeName>:<attributeValue>,...}
}

Response body

{
  {<attributeName>:<attributeValue>,...}
}

post /update
Click here to expand...

Updates a service. The request contains only the service ID and any updated attributes. The server updates the modifiedDate and returns it with the service ID.

Note

  • previousVersion is optional.
  • Convert the list of strings (accessGroups attribute) into one string that is a semicolon-separated list.
Request body

{ "ServiceAvailability":{"id":<String>,"changes":{<attributeName>:<attributeValue>,...}, "previousVersion":{<attributeName>:<attributeValue>,...} } }

Response body

{
  "ServiceAvailability":{"id":<String>,"modifiedDate":<Number>}
}


user services

post /update
Click here to expand...

Updates a user's subscribed status or notification setting for a service. It also checks the status and sends a user notification if the status changes.

Note

previousVersion is optional.

Parameters

Name

Required/Optional

Description

Type

id

Required

ID of the user service.

String

userId

Optional

ID of the user.

String

name

Required

Name of the user service.

String

desc

Optional

Description of the user service.

String

iconId

Optional

ID of the service icon.

String

annotation

Optional

Annotation of the service.

String

status

Required

Status of the service.

Integer

isEnabled

Optional

Not applicable.

Boolean

isAutoSubscribe

Optional

Not applicable.

Boolean

subscribed

Optional

Specific to the user who makes the query.

Boolean

notificationSetting

Optional

Specific to the user who makes the query.. Valid values are DEFAULT, NONE, EMAIL, DEVICE, BOTH. DEFAULT translates to DEVICE.

String

createDate

Required

Date of the service creation.

Date

modifiedDate

Optional

Last modified date of the floor map image.

Date

Request body

{ "UserService":{"id":<String>,"changes":{"subscribed":<Boolean>,"notificationSetting":<String>},"previousVersion":{"subscribed":<Boolean>,"notificationSetting":<String>}} }

Response body

{
  "UserService":{"id":<String>,"modifiedDate":<Number>}
}


Object Definitions

Object

Schema

Action

Click here to expand...

{
   name: string
   action name
    Example: action 0

   type: string
   action type, ANSWER_QUESTION or OPEN_QUESTIONNAIRE
   Enum: [
     "OPEN_QUESTIONNAIRE",
     "ANSWER_QUESTION"
   ]
    Example: ANSWER_QUESTION

   mapping: #TableMapping
   action mapping

   qualification: #QualificationExpression
   action qualification
}

ActionDescriptor

Click here to expand...

{
   name: string
   externalActivityFactory: boolean
   externalActivityModifier: boolean
   externalActivityType: string
   actionOutputCaptures: [
      #ActionOutputCapture
   ]
}

ActionOutputCapture

Click here to expand...

{
   expression: string
   outputAssignment: string
   Enum: [
     "EXTERNAL_ACTIVITY_ID",
     "EXTERNAL_ACTIVITY_DISPLAY_ID",
     "EXTERNAL_ACTIVITY_SECONDARY_ID",
     "EMAIL_SUBJECT",
     "EMAIL_BODY",
     "SUB_CATALOG_ID"
   ]
}

ActivityLog

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceRequestId: string
   message: string
   authorLoginId: string
   authorFullName: string
   attachmentFileName: string
   attachmentMimeType: string
   attachmentSize: integer
   sourceSystem: string
   visibility: string
   Enum: [
     "PUBLIC",
     "INTERNAL"
   ]
   broadcast: boolean
   userList: string
   broadcastStatus: string
   externalId: string
   externalActivityId: string
}

ActivityLogAttachment

Click here to expand...

{
   id: string
   name: string
   size: integer
   mediaType: string
}

ActivityLogDetails

Click here to expand...

{
   id: string
   serviceRequestId: string
   message: string
   authorLoginId: string
   authorFullName: string
   createDate: date-time
   modifiedDate: date-time
   visibility: string
   Enum: [
     "PUBLIC",
     "INTERNAL"
   ]
   attachments: [
      #ActivityLogAttachment
   ]
}

ActivityLogDto

Click here to expand...

{
   text: string
   authorLoginID: string
   visibility: string
   broadcast: boolean
   externalId: string
   externalExternalActivityId: string
   externalActivityType: string
}

AnswerChange

Click here to expand...

{
   answer: [
     string
   ]
}

ApiConnection

Click here to expand...

{
   id: string
   name: string
   definition: #ConnectionDefinition
   connectionOptions: {
   }
}

ApiConnector

Click here to expand...

{
   id: string
   rxBundleId: string
   name: string
   connectorName: string
   modifiedDate: date-time
   version: string
   connectorStatus: string
   Enum: [
     "UNCONFIGURED",
     "CONNECTED",
     "CONNECTION_FAILED",
     "MISSING",
     "NOT_SERVICE_CONNECTOR",
     "DISABLED"
   ]
   serviceConnectorUri: uri
   rxConnectionId: string
   panamaAppId: string
   panamaConfigId: string
   panamaProfileId: string
   rcfConnectorType: string
   rcfConnectionInstanceId: string
   connection: #ApiConnection
}

ApiConnectors

Click here to expand...

{
   connectors: [
      #Connection
   ]
}

AssetClass

Click here to expand...

{
   name: string
   externalId: string
   children: [
      #AssetClass
   ]
}

AssetClassAttribute

Click here to expand...

{
   id: string
   name: string
   type: string
}

AssetClassDto

Click here to expand...

{
   id: string
   externalId: string
   name: string
   conditionName: string
   condition: #QualificationExpression
}

AssetClassMappingDTO

Click here to expand...

{
   externalId: string
   external id
    Example: 9717

   name: string
   name of the mapping
    Example: CreateIncident

   available: boolean
}

AssetConnectionMappingDTO

Click here to expand...

{
   assetClassMappings: [
     a list of asset from external system

      #AssetClassMappingDTO
   ]

   mappingState: string
   mapping status
   Enum: [
     "MAPPED_TO_NONE",
     "MAPPED_TO_CURRENT",
     "MAPPED_TO_PARTIAL",
     "MAPPED_TO_OTHER"
   ]
}

AssetGroupDTO

Click here to expand...

{
   modifiedDate: date-time
   connectionsStatus: string
   Enum: [
     "ALL_CONNECTED",
     "HAS_NON_CONNECTED"
   ]
   name: string
   id: string
}

AssetGroupListPaginationDTO

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   data: [
      #AssetGroupDTO
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

AssetGroupTranslation

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   groupId: string
   name: string
   locale: string
}

AssetGroupTranslationDTO

Click here to expand...

{
   name: string
   name in other language
    Example: name(in French)

   locale: string
   locale
    Example: en

   useDefaultLanguage: boolean
   if use the default language
    Example: true
}

AssetMappingDTO

Click here to expand...

{
   assetGroupId: string
   mappedServiceCount: integer
   the number of mapped services
    Example: 1

   translations: [
     translation

      #AssetGroupTranslationDTO
   ]

   assetConnectionMappings: {
     a list of asset mappings to connections
   }

   assetServiceCategoryMappings: [
     a list of asset mappings to external system

      #AssetClassMappingDTO
   ]
}

AssetServiceDTO

Click here to expand...

{
   id: string
   logoUrl: string
   name: string
}

AssetServiceMappingDTO

Click here to expand...

{
   id: string
   isAvailable: boolean
}

AssetStatus

Click here to expand...

{
   id: string
   name: string
   type: string
   Enum: [
     "PENDING",
     "AVAILABLE",
     "UNAVAILABLE",
     "RETIRED"
   ]
}

Attachment

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   defaultAnswers: [
     string
   ]
   metaData: {
   }
}

AttachmentMetaData

Click here to expand...

{
   contentId: string
   fileName: string
   mimeType: string
}

AuthRedirect

Click here to expand...

{
   inputs: [
     string
   ]
   outputs: [
     string
   ]
}

AvailabilityMetric

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   description: string
   uptime: number
}

Banner

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   bannerImages: [
      #BannerImage
   ]
   bannerSettings: [
      #BannerSetting
   ]
   name: string
   scheduleTimezone: string
   activationDatetime: date-time
   deactivationDatetime: date-time
   displayActivationDatetime: string
   displayDeactivationDatetime: string
   archiveOnDeactivation: boolean
   state: string
   Enum: [
     "DRAFT",
     "PUBLISHED",
     "ARCHIVED"
   ]
   ios: boolean
   android: boolean
   osx: boolean
   windows: boolean
   linux: boolean
   platforms: [
     string
     Enum: [
       "IOS",
       "WINDOWS",
       "ANDROID",
       "OSX",
       "LINUX"
     ]
   ]
   subCatalogId: string
}

BannerDto

Click here to expand...

{
   id: string
   activationDatetime: string
   deactivationDatetime: string
   name: string
   state: string
   modifiedDate: date-time
   scheduleTimezone: string
   platforms: [
     string
   ]
   bannerImages: [
      #BannerImage
   ]
   bannerSettings: [
      #BannerSetting
   ]
   previewImageUrl: string
   subCatalog: #SubCatalogDTO
}

BannerImage

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   locale: string
   imageType: string
   fileId: string
   bannerType: string
   imageUrl: string
   useDefaultLanguage: boolean
}

BannerScheduleDto

Click here to expand...

{
   timezonesWithOffset: [
      #TimezoneDetails
   ]
   activationDatetime: string
   deactivationDatetime: string
   archiveOnDeactivation: boolean
   scheduleTimezone: #TimezoneDetails
}

BannerSearchDto

Click here to expand...

{
   name: string
   bannerIds: [
     string
   ]
   bannerTypes: [
     string
   ]
   imageTypes: [
     string
   ]
   platforms: [
     string
   ]
   bannerState: string
   activeOnly: boolean
   sortBy: string
   sortDirection: string
   page: integer
   pageSize: integer
   userId: string
   subCatalogIds: [
     string
   ]
   currentUserSubCatalogOnly: boolean
}

BannerSearchResultDto

Click here to expand...

{
   banners: [
      #BannerDto
   ]
   stateCounts: {
   }
   page: integer
   pageSize: integer
   total: integer
}

BannerSetting

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   general: boolean
   platform: string
   Enum: [
     "IOS",
     "WINDOWS",
     "ANDROID",
     "OSX",
     "LINUX"
   ]
   linkType: string
   Enum: [
     "URL",
     "SERVICE",
     "NONE"
   ]
   linkServiceId: string
   linkUrl: string
   linkServiceName: string
}

BannerStateChangeDto

Click here to expand...

{
   bannerIds: [
     string
   ]
   state: string
}

BaseUrlDto

Click here to expand...

{
   baseUrl: string
}

BasicRevisionView

Click here to expand...

{
   name: string
   Revision name
    Example: Euro Currency

   id: string
   Revision Id
    Example: 16529

   state: string
   Revision state
    Example: approved

   modifiedDate: date-time
   fulfillmentType: string
   Enum: [
     "INTERNAL_WORKFLOW",
     "EXTERNAL_LINK",
     "EXTERNAL_EMBEDDED"
   ]
   workflowId: string
    Example: rx-a3b3b0b3-ef69-4ee7-b8e6-af9e295cde70
   multiRequestBundle: boolean
   unavailableRequiredServicesCount: integer
}

BasicServiceTemplateView

Click here to expand...

{
   name: string
   The name of the template
    Example: Desktop

   id: string
   The template Id
    Example: 2

   templateType: string
   The template type
   Enum: [
     "SERVICE",
     "BUNDLE",
     "CONNECTOR",
     "DAY_2_ACTION"
   ]
    Example: SERVICE
}

BodyPart

Click here to expand...

{
   contentDisposition: #ContentDisposition
   entity: {
   }
   headers: {
   }
   mediaType: #MediaType
   messageBodyWorkers: #MessageBodyWorkers
   parent: #MultiPart
   providers: #Providers
   parameterizedHeaders: {
   }
}

BundleDto

Click here to expand...

{
   id: string
   serviceId: string
   serviceVersionId: string
   bundledVersions: [
      #SbeBundleService
   ]
   bundleState: #SbeBundleState
   profile: #ServiceRevisionProfileDto
   questionnaireId: string
   questionnaireGroupId: string
   questionnaireName: string
   sla: #Sla
   costQuantity: #ServiceCostQuantityDto
   name: string
   revisionState: string
   multiRequestBundle: boolean
   workflowId: string
   workflowName: string
   quickRequest: boolean
   subCatalogId: string
   version: string
}

BundleServiceCostQuantityDto

Click here to expand...

{
   bundleServiceName: string
   costAdjustment: #CostAdjustment
   price: #SbeServicePrice
   quantity: integer
   serviceVersionId: string
}

BundleWorkflowDto

Click here to expand...

{
   bundledVersionIds: [
     string
   ]
   workflowId: string
   questionnaireGroupId: string
   multiRequest: boolean
}

CatalogDTO

Click here to expand...

{
   id: string
   name: string
   connectorName: string
   serviceCount: integer
   allServicesMapped: boolean
   selectedServices: integer
   importedServices: integer
   publisher: string
   modified: date-time
   importStatus: string
   Enum: [
     "READY_TO_IMPORT",
     "PARTIALLY_IMPORTED",
     "IMPORTED",
     "NEED_TO_UPDATE",
     "IN_PROGRESS",
     "ERROR"
   ]
   connectorId: string
   connectorStatus: string
   Enum: [
     "UNCONFIGURED",
     "CONNECTED",
     "CONNECTION_FAILED",
     "MISSING",
     "NOT_SERVICE_CONNECTOR",
     "DISABLED"
   ]
}

CatalogImportConnectorField

Click here to expand...

{
   name: string
}

CatalogImportRequest

Click here to expand...

{
   overwriteMetadata: boolean
   id: string
}

CatalogImportSelection

Click here to expand...

{
   categorySelectIds: [
     string
   ]
   serviceSelectIds: [
     string
   ]
   categoryDeselectIds: [
     string
   ]
   serviceDeselectIds: [
     string
   ]
}

CatalogPaginationDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   catalogs: [
      #CatalogDTO
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

CategoryDto

Click here to expand...

{
   id: string
   name: string
}

CategoryPaginationDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   categories: [
      #SbeCategory
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

Checkbox

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   options: [
      #QuestionOption
   ]
   connectorId: string
   datasetId: string
   datasetName: string
   datasetIdFieldId: string
   datasetIdFieldName: string
   datasetNameFieldId: string
   datasetNameFieldName: string
   qualification: string
   qualificationExpression: #QualificationExpression
   useCustomQualification: boolean
   defaultAnswers: [
     string
   ]
}

CmdbMapping

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   cmdbServiceId: string
   cmdbOfferingId: string
   cmdbRequestableOfferingType: string
   Enum: [
     "TRANSACTIONAL",
     "DELIVERY"
   ]
   cmdbRequestableOfferingId: string
   srmImported: boolean
   cmdbServiceName: string
   cmdbOfferingName: string
   pendingReconciliation: boolean
}

CompanyDto

Click here to expand...

{
   id: string
   name: string
}

Connection

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   rxBundleId: string
   name: string
   version: string
   connectorStatus: string
   Enum: [
     "UNCONFIGURED",
     "CONNECTED",
     "CONNECTION_FAILED",
     "MISSING",
     "NOT_SERVICE_CONNECTOR",
     "DISABLED"
   ]
   connectorName: string
   rxConnectionId: string
   panamaAppId: string
   panamaConfigId: string
   panamaProfileId: string
   componentStatus: string
   Enum: [
     "MISSING",
     "ACTIVE",
     "DISABLED"
   ]
   showMyStuffItems: boolean
   panamaConnectorLowerCaseName: string
   rcfConnectorType: string
   rcfConnectionInstanceId: string
   connectionId: string
   metadataOrDefault: #ConnectorMetaData
}

ConnectionDefinition

Click here to expand...

{
   options: [
      #ConnectionOption
   ]
   authRedirect: #AuthRedirect
}

ConnectionDto

Click here to expand...

{
   id: string
   name: string
   connectorName: string
   connectorId: string
}

ConnectionOption

Click here to expand...

{
   name: string
   type: string
   Enum: [
     "STRING",
     "PASSWORD",
     "INTEGER"
   ]
}

ConnectorDTO

Click here to expand...

{
   connectorId: string
   label: string
}

ConnectorDataset

Click here to expand...

{
   connectorId: string
   connectionName: string
   connectorName: string
   id: string
   name: string
   serviceId: string
   serviceDisplayId: string
   serviceName: string
   queryable: boolean
   fields: [
      #DatasetField
   ]
   params: [
      #DatasetParam
   ]
}

ConnectorDay2Action

Click here to expand...

{
   type: string
   Enum: [
     "EXTERNAL_WEB_SITE",
     "REQUEST",
     "CONNECTOR"
   ]
   name: string
   The Day 2 action name
    Example: Demo Day 2 action

   id: string
}

ConnectorIdExternalOrderIdPair

Click here to expand...

{
   connectorId: string*
   The connector ID
    Example: 1

   externalOrderId: string*
   The order ID in another application integrated with BMC Digital Workplace Catalog, such as BMC Helix ITSM
    Example: 000000000000004
}

ConnectorMetaData

Click here to expand...

{
   actionDescriptors: [
      #ActionDescriptor
   ]
   catalogProvider: boolean
   datasetProvider: boolean
   queryableDatasetProvider: boolean
   tableDatasetProvider: boolean
   assetProvider: boolean
   assetClassProvider: boolean
   activityProvider: boolean
   categoryProvider: boolean
   questionnaireEventHandler: boolean
   orderAware: boolean
   userProvider: boolean
   activityLogProvider: boolean
   expectsCallback: boolean
   subCatalogProvider: boolean
   serviceRequestAware: boolean
   companyProvider: boolean
   actions: [
      #ActionDescriptor
   ]
}

ConnectorSummariesDto

Click here to expand...

{
   connectors: [
      #ConnectorSummary
   ]
}

ConnectorSummary

Click here to expand...

{
   name: string
   version: string
   rxBundleId: string
   panamaAppId: string
   panamaConnectorLowerCaseName: string
   rcfConnectorType: string
   configs: [
      {
     }
   ]
   id: string
}

Content

Click here to expand...

{
   binaryData: [
     byte
   ]
   fileName: string
   mediaType: string
}

ContentDisposition

Click here to expand...

{
   type: string
   parameters: {
   }
   fileName: string
   creationDate: date-time
   modificationDate: date-time
   readDate: date-time
   size: integer
}

CoreServiceDto

Click here to expand...

{
   id: string
   The service ID
    Example: 14418

   name: string
   The service name
    Example: Request Time Off

   templateName: string
   The name of the template being used for the core service object in the BMC Digital Workplace GUI
    Example: Desktop

   templateId: string
   The template ID
    Example: 123

   templateType: string
   The kind of template being used. Available types are SERVICE for services, BUNDLE for service bundles, CONNECTOR for connectors, and DAY_2_ACTION for Day 2 actions
   Enum: [
     "SERVICE",
     "BUNDLE",
     "CONNECTOR",
     "DAY_2_ACTION"
   ]
    Example: SERVICE

   modifiedDate: date-time
   When the core service was last modified
    Example: 2018-10-02T21:42:30.000+0000

   subCatalogId: string
   The ID of the sub-catalog associated with the service
    Example: 1

   subCatalogName: string
    Example: BWF
}

CoreServiceRevisionDto

Click here to expand...

{
   id: string
   The service or Day 2 action revision ID
    Example: 16524

   name: string
   The service or Day 2 action revision name
    Example: Test service

   templateName: string
   The name of the template that is used for this service, Day 2 action, or service bundle in the BMC Digital Workplace GUI
    Example: Day 2 action

   templateId: string
   The ID of the template that is used for this service, Day 2 action, or service bundle in the BMC Digital Workplace GUI

   serviceId: string
   The service or Day 2 action's ID
    Example: 14411

   serviceVersionId: string
   The service or Day 2 action's version ID in the database
    Example: 1

   version: string
   The service or Day 2 action's version name
    Example: 01

   templateType: string
   Template type
   Enum: [
     "SERVICE",
     "BUNDLE",
     "CONNECTOR",
     "DAY_2_ACTION"
   ]
    Example: SERVICE

   modifiedDate: date-time
   When the object record was last modified in the system database in UTC datetime format
    Example: 2018-09-28T18:41:44.000+0000

   state: string
   The service state
    Example: published

   fulfillmentUrl: string
   The URL of the external fulfillment system, if applicable: for instance, if you are buying a mouse from a third-party website
    Example: blank

   fulfillmentType: string
   How the service or Day 2 action request is being fulfilled
   Enum: [
     "INTERNAL_WORKFLOW",
     "EXTERNAL_LINK",
     "EXTERNAL_EMBEDDED"
   ]
    Example: INTERNAL_WORKFLOW

   workflowId: string
   workflowName: string
   The name of the workflow associated with the record
    Example: Case creation workflow

   questionnaireId: string
   The questionnaire ID associated with the record
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   questionnaireGroupId: string
   The questionnaire group ID associated with the record
    Example: 9f111d32-2ac3-4e48-b162-7224ca41ec4e

   questionnaireName: string
   The name of the questionnaire associated with the record
    Example: System preferences questionnaire

   multiRequestBundle: boolean
   Indicates whether the record represents a multi-service request bundle or not

   excerpt: string
   A brief description of the service, Day 2 action, or multi-service bundle
    Example: Apple Care add-on for MacBooks

   logoUrl: string
   A URL for the logo used in the GUI form for the service, Day 2 action, or multi-service bundle in BMC Digital Workplace
    Example: /api/myit-sb/content/AGGADGG8ECDC0AP5QDACP4TEVOD8XF

   available: boolean
   Indicates if the particular service, Day 2 action, or multi-service bundle is available for the current caller or not

   quickRequest: boolean
   Whether a service is set to be available for quick requests or not. End users requesting a quick request service will be taken directly to the associated questionnaire or checkout page

   unavailableRequiredServicesCount: integer
   The number of unavailable items in a bundle
    Example: 0

   subCatalogId: string
   The sub-catalog ID associated with the record
    Example: null

   subCatalogName: string
   The name of the sub-catalog associated with the record
    Example: null
}

CoreServiceVersionIDto

Click here to expand...

{
   name: string
   serviceversionId: string
   available: boolean
   serviceVersionId: string
}

CostAdjustment

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   offsets: [
      #CostOffset
   ]
   serviceRevisionId: string
}

CostAdjustmentProfile

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   offsets: [
      #CostOffset
   ]
   serviceRevisionId: string
   profileName: string
}

CostOffset

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   value: number
   paymentFrequency: string
   Enum: [
     "ONCE",
     "MONTHLY",
     "YEARLY"
   ]
   offsetDetails: [
      #CostOffsetDetail
   ]
   category: #OffsetCategory
}

CostOffsetDetail

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   category: string
   value: number
}

CreateExternalCategoryMappingRequest

Click here to expand...

{
   externalCategory: #ExternalCategoryDTO
   categoryIds: [
     string
   ]
}

Currency

Click here to expand...

{
   currencyCode: string
   displayName: string
   defaultFractionDigits: integer
   numericCode: integer
   symbol: string
}

DatasetField

Click here to expand...

{
   id: string
   name: string
}

DatasetLookupDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   lookupConnectors: [
      #ConnectionDto
   ]
   resultItems: [
     Lists the results

      #ConnectorDataset
   ]

   total: integer
   The total number of matching records for the current query
    Example: 1
}

DatasetParam

Click here to expand...

{
   id: string
}

DateField

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   defaultAnswer: string
   timezoneId: string
   min: #DateLimit
   max: #DateLimit
}

DateLimit

Click here to expand...

{
   limitType: string
   Enum: [
     "NO_LIMIT",
     "CURRENT",
     "SPECIFIC",
     "RELATIVE"
   ]
   specificLimit: string
   relativeLimit: #RelativeLimit
   computedLimit: string
}

DateRangeField

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   defaultAnswer: string
}

DateTimeField

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   defaultAnswer: string
   timezoneId: string
   min: #DateLimit
   max: #DateLimit
}

Day2Action

Click here to expand...

{
   type: string
   Enum: [
     "EXTERNAL_WEB_SITE",
     "REQUEST",
     "CONNECTOR"
   ]
   name: string
   The Day 2 action name
    Example: Demo Day 2 action
}

Day2ActionCategoriesDto

Click here to expand...

{
   categories: [
      #CategoryDto
   ]
   count: integer
}

Day2ActionConnectionDto

Click here to expand...

{
   connectionId: string
   name: string
   state: string
   showMyStuffItems: boolean
   allSelected: boolean
   assetClasses: [
      #AssetClassDto
   ]
   condition: string
   conditionName: string
}

Day2ActionCountDto

Click here to expand...

{
   servicesAttachedTo: integer
   connectionsAttachedTo: integer
   assetClassesAttachedTo: integer
}

Day2ActionStatisticsDto

Click here to expand...

{
   active: integer
   inactive: integer
}

Day2ActionStatusChangeRequest

Click here to expand...

{
   id: string
   active: boolean
}

DefaultField

Click here to expand...

{
   name: string
   type: string
   Enum: [
     "UNDEFINED",
     "CHECKBOX",
     "DROPDOWN",
     "RADIO",
     "SINGLELINE_INPUT",
     "MULTILINE_INPUT",
     "RICH_INPUT",
     "MEDIA_CAROUSEL",
     "RESOURCES",
     "UNUSED",
     "CONNECTOR"
   ]
   required: boolean
}

DependedEntity

Click here to expand...

Subclasses:
#DependedService

{
}

DependedService

Click here to expand...

{
   service: #SbeServiceVersion
}

DescriptionWidget

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   description: string
}

DocumentType

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
}

Dropdown

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   options: [
      #QuestionOption
   ]
   connectorId: string
   datasetId: string
   datasetName: string
   datasetIdFieldId: string
   datasetIdFieldName: string
   datasetNameFieldId: string
   datasetNameFieldName: string
   qualification: string
   qualificationExpression: #QualificationExpression
   useCustomQualification: boolean
   defaultAnswer: string
}

DynamicField

Click here to expand...

{
   title: string
   content: {
   }
   documents: [
      #SbeServiceDocument
   ]
}

EntitleEveryoneDTO

Click here to expand...

{
   entitleEveryone: boolean
}

ExternalActivityInServiceRequestDetail

Click here to expand...

{
   externalActivityId: string
   externalActivityDisplayId: string
   activityStatus: string
   Enum: [
     "NEW",
     "WAITING_FOR_APPROVAL",
     "APPROVED",
     "REJECTED",
     "IN_PROGRESS",
     "COMPLETED",
     "FAILED",
     "CANCELLED",
     "CLOSED",
     "PENDING"
   ]
   activitySubStatus: string
   summary: string
   activityType: string
   statusReason: string
   modifiedDate: date-time
}

ExternalCategoryDTO

Click here to expand...

{
   id: string
   name: string
   parentId: string
   connectorId: string
}

ExternalCategoryMappingDTO

Click here to expand...

{
   id: string
   externalCategoryId: string
   externalCategoryName: string
   connectorId: string
   categoryId: string
   categoryName: string
   connectorName: string
}

FieldMapping

Click here to expand...

{
   fieldName: string
   Field Name
    Example: action

   fieldId: string
   Field Id
    Example: field id 0

   questionLabel: string
   Question Label
    Example: DATASET ID

   questionId: string
   Question Id
    Example: Question Id 0
}

FieldTypeChoice

Click here to expand...

{
   type: string
   Enum: [
     "UNDEFINED",
     "CHECKBOX",
     "DROPDOWN",
     "RADIO",
     "SINGLELINE_INPUT",
     "MULTILINE_INPUT",
     "RICH_INPUT",
     "MEDIA_CAROUSEL",
     "RESOURCES",
     "UNUSED",
     "CONNECTOR"
   ]
   singleton: boolean
}

File

Click here to expand...

{
   path: string
   name: string
   parent: string
   absolute: boolean
   canonicalPath: string
   parentFile: #File
   absolutePath: string
   absoluteFile: #File
   canonicalFile: #File
   directory: boolean
   file: boolean
   hidden: boolean
   totalSpace: integer
   freeSpace: integer
   usableSpace: integer
}

FindExternalCategoriesResponse

Click here to expand...

{
   connectors: [
      #ConnectorDTO
   ]
   categories: [
      #ExternalCategoryDTO
   ]
}

FormDataBodyPart

Click here to expand...

{
   contentDisposition: #ContentDisposition
   entity: {
   }
   headers: {
   }
   mediaType: #MediaType
   messageBodyWorkers: #MessageBodyWorkers
   parent: #MultiPart
   providers: #Providers
   name: string
   value: string
   simple: boolean
   formDataContentDisposition: #FormDataContentDisposition
   parameterizedHeaders: {
   }
}

FormDataContentDisposition

Click here to expand...

{
   type: string
   parameters: {
   }
   fileName: string
   creationDate: date-time
   modificationDate: date-time
   readDate: date-time
   size: integer
   name: string
}

FormDataMultiPart

Click here to expand...

{
   contentDisposition: #ContentDisposition
   entity: {
   }
   headers: {
   }
   mediaType: #MediaType
   messageBodyWorkers: #MessageBodyWorkers
   parent: #MultiPart
   providers: #Providers
   bodyParts: [
      #BodyPart
   ]
   fields: {
   }
   parameterizedHeaders: {
   }
}

FullCatalogViewDTO

Click here to expand...

{
   fullCatalogView: boolean
}

GetAssetClassAttributesResponse

Click here to expand...

{
   attributes: [
      #AssetClassAttribute
   ]
}

GetExternalCategoryMappingsResponse

Click here to expand...

{
   id: string
   connectorId: string
   count: integer
   mappings: [
      #ExternalCategoryMappingDTO
   ]
}

HealthCheckDTO

Click here to expand...

{
   status: string
   Enum: [
     "PASSED",
     "FAILED",
     "UNKNOWN"
   ]
   enabled: boolean
   additionalInfo: string
}

ImportServiceTypeDataMapping

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceTypeFieldId: string
   connectorFieldName: string
}

Label

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   text: string
   type: string
   Enum: [
     "FREE_SERVICE_TEXT"
   ]
   editable: boolean
   defaultLabel: boolean
   labelLocalization: #LabelLocalization
}

LabelLocalization

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   useDefaultLocale: boolean
   localizedText: string
}

LeadingQuestionCondition

Click here to expand...

{
   leadingQuestionId: string
   leading Question Id
    Example: Q1

   leadingQuestionExpectedAnswers: [
     a list of LeadingQuestionExpectedAnswers

     string
   ]

   expression: #QualificationExpression
}

LegacyMyStuffItem

Click here to expand...

{
   id: string
   name: string
   excerpt: string
   iconUrl: string
   rating: number
   modifiedDate: date-time
   createdDate: date-time
   ratingCount: integer
   categories: [
      #SbeCategory
   ]
   price: #Price
   provisioningTime: #ProvisioningTimeMetric
   serviceType: string
   dynamicStatus: [
      #MyStuffStatus
   ]
   externalId: string
   externalWorkflow: string
   Enum: [
     "SRM",
     "CLM",
     "LINK",
     "OTHER"
   ]
   availableDay2Actions: [
      #ConnectorDay2Action
   ]
   description: string
}

LocalizedBundleDto

Click here to expand...

{
   id: string
   serviceId: string
   serviceVersionId: string
   bundledVersions: [
      #SbeBundleService
   ]
   bundleState: #SbeBundleState
   localizedProfile: {
   }
   questionnaireId: string
   questionnaireGroupId: string
   questionnaireName: string
   sla: #Sla
   costQuantity: #ServiceCostQuantityDto
   name: string
   revisionState: string
   multiRequestBundle: boolean
   quickRequest: boolean
   workflowId: string
   workflowName: string
   subCatalogId: string
}

LoginDto

Click here to expand...

{
   authenticated: boolean
   sbGroup: string
   user: #User
   tenantMode: string
   Enum: [
     "FULL",
     "LITE"
   ]
   integrationService: boolean
   deploymentType: string
   Enum: [
     "ONCLOUD",
     "ONPREM"
   ]
}

LogoWithUrlDto

Click here to expand...

{
   id: string
   url: string
   locale: string
}

Lookup

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   options: [
      #QuestionOption
   ]
   connectorId: string
   datasetId: string
   datasetName: string
   datasetIdFieldId: string
   datasetIdFieldName: string
   datasetNameFieldId: string
   datasetNameFieldName: string
   qualification: string
   qualificationExpression: #QualificationExpression
   useCustomQualification: boolean
   defaultAnswer: string
   lookupThreshold: integer
}

LookupRequest

Click here to expand...

{
   query: string
}

LookupResponse

Click here to expand...

{
   options: [
      #QuestionOption
   ]
}

Marketplace

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
}

MediaType

Click here to expand...

{
   type: string
   subtype: string
   parameters: {
   }
   wildcardType: boolean
   wildcardSubtype: boolean
}

MessageBodyWorkers

Click here to expand...

{
}

Metric

Click here to expand...

Subclasses:
#AvailabilityMetric
#SupportResponseMetric

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   description: string
}

MigrationStatus

Click here to expand...

{
   status: string
   Enum: [
     "APPLICATION_STARTUP",
     "MIGRATION_REQUIRED",
     "RUNNING",
     "INTERRUPTED_BY_ERROR",
     "NOT_REQUIRED",
     "LOCKED",
     "FINISHED"
   ]
   currentlyRunningMigration: string
   currentlyRunningTenant: string
   currentlyRunningMigrationStatus: string
}

MultiPart

Click here to expand...

{
   contentDisposition: #ContentDisposition
   entity: {
   }
   headers: {
   }
   mediaType: #MediaType
   messageBodyWorkers: #MessageBodyWorkers
   parent: #MultiPart
   providers: #Providers
   bodyParts: [
      #BodyPart
   ]
   parameterizedHeaders: {
   }
}

MultiSelectDropdown

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   options: [
      #QuestionOption
   ]
   connectorId: string
   datasetId: string
   datasetName: string
   datasetIdFieldId: string
   datasetIdFieldName: string
   datasetNameFieldId: string
   datasetNameFieldName: string
   qualification: string
   qualificationExpression: #QualificationExpression
   useCustomQualification: boolean
   defaultAnswers: [
     string
   ]
}

MyServiceNotFoundException

Click here to expand...

{
   cause: #Throwable
   stackTrace: [
      #StackTraceElement
   ]
   errorCode: integer
   message: string
   requestMessages: [
      #RequestMessage
   ]
   firstMessageNum: integer
   localizedMessage: string
   suppressed: [
      #Throwable
   ]
}

MyStuffActionRequest

Click here to expand...

{
   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   myStuffItemId: string
   myStuffActionId: string
}

MyStuffAssetGroup

Click here to expand...

{
   id: string
   The asset group ID
    Example: 1303

   items: [
     A list of asset items belonging associated with the associated asset group's *id*

      #MyStuffItem
   ]

   name: string
   The asset group name
    Example: Test asset group

   totalItemCount: integer
   The total number of items in the asset group
    Example: 1
}

MyStuffItem

Click here to expand...

{
   id: #MyStuffItemId
   The item ID

   name: string
   My Stuff item name
    Example: Test action

   description: string
   The My Stuff item description
    Example: Some description

   iconUri: uri
   The URI of the icon used in the My Stuff item's form in the BMC Digital Workplace GUI
    Example: /api/myit-sb/content/AGGADGG8ECDC0AP5QDACP4TEVOD8XF

   status: #AssetStatus
   The My Stuff item status

   categories: [
     A list of My Stuff item asset groups/categories

      #MyStuffItemAssetGroupDto
   ]
}

MyStuffItemAssetGroupDto

Click here to expand...

{
   id: string
   The My Stuff category ID
    Example: U0VSVklDRV9NVFE0TURjX2FHRnVibUZvWDJGa2JXbHU

   name: string
   MyStuff category name
    Example: Computer software

   parentId: string
   MyStuffItem categorie parent id if any
    Example: null
}

MyStuffItemDetails

Click here to expand...

{
   iconUri: uri
   The URI of the icon associated with the My Stuff item in the BMC Digital Workplace GUI
    Example: /api/myit-sb/content/AGGADGG8ECDC0AP5QDACP4TEVOD8XF

   name: string
   The My Stuff item name
    Example: Test item

   id: string
   The My Stuff item ID
    Example: 123
}

MyStuffItemId

Click here to expand...

{
   type: string
   The My Stuff item type
   Enum: [
     "SERVICE",
     "ASSET"
   ]

   serviceId: string
   The service ID associated with the My Stuff item
    Example: 14411

   connectorId: string
   The connector ID associated with the My Stuff item
    Example: 1

   assetId: string
   The asset ID associated with the My Stuff item
    Example: 123

   assetOwner: string
   The login ID of the user who owns the asset identified by *assetId*
    Example: Allen
}

MyStuffItemsConfigSettings

Click here to expand...

{
   assetConnectorSettings: #MyStuffItemsSourceGroupSettings
   Asset Connector Settings

   serviceRequestSettings: #MyStuffItemsSourceGroupSettings
   Service request Settings
}

MyStuffItemsSourceGroupSettings

Click here to expand...

{
   enabled: boolean
   items: [
     a list of MyStuffItemsSourceSettings

      #MyStuffItemsSourceSettings
   ]
}

MyStuffItemsSourceSettings

Click here to expand...

{
   id: string
   id
    Example: 1501

   name: string
   name
    Example: Microsoft Office 365

   state: string
   state, CONNECTED or CONNECTION_FAILED
    Example: CONNECTED

   enabled: boolean
   hasClassification: boolean
}

MyStuffStatus

Click here to expand...

{
   id: string
   name: string
   type: string
   Enum: [
     "UNKNOWN",
     "PENDING",
     "AVAILABLE",
     "FULFILLED",
     "CANCELLED",
     "RETIRED"
   ]
}

Notification

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   receiver: string
   title: string
   content: string
   externalId: string
   read: boolean
   dismissed: boolean
   iconUri: string
   actionType: string
   actionParams: {
   }
}

NotificationListPaginationDTO

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   data: [
      #Notification
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

OffsetCategory

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   editable: boolean
   localization: #OffsetCategoryLocalization
}

OffsetCategoryLocalization

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   useDefaultLocale: boolean
   localizedName: string
}

OptionsChange

Click here to expand...

{
   options: [
      #QuestionOption
   ]
}

PageItemWidget

Click here to expand...

Subclasses:
#DateField
#YesNo
#SectionWidget
#TextArea
#DescriptionWidget
#Lookup
#Attachment
#TimeField
#TextField
#Dropdown
#RadioButtons
#PasswordField
#DateTimeField
#MultiSelectDropdown
#Checkbox
#DateRangeField

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition
}

PageWidget

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   title: string
   pageItems: [
      #PageItemWidget
   ]
}

ParameterizedHeader

Click here to expand...

{
   value: string
   parameters: {
   }
}

PasswordField

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   defaultAnswer: string
   maxLength: integer
   minLength: integer
}

Person

Click here to expand...

{
   id: string
   loginName: string
   fullName: string
   email: string
   companyId: string
   company: string
   organization: string
   department: string
   jobTitle: string
   region: string
   siteGroup: string
   site: #Site
}

PersonCriteriaDatasetItemDto

Click here to expand...

{
   id: string
   name: string
   path: string
}

PersonCriteriaDatasetItemPaginationDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   path: string
   hasNextPage: boolean
   items: [
      #PersonCriteriaDatasetItemDto
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

Policy

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   description: string
   status: string
   Enum: [
     "INACTIVE",
     "ACTIVE"
   ]
   links: [
      #PolicyLink
   ]
   complianceReview: string
   Enum: [
     "TRUE",
     "FALSE"
   ]
}

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   link: string
}

Price

Click here to expand...

{
   paymentType: string
   freeLabelText: string
   price: number
   currency: string
   paymentSchedule: string
}

ProcessInputConfig

Click here to expand...

{
   processInputs: [
      #ProcessInputTypeMultiChoice
   ]
}

ProcessInputTypeMultiChoice

Click here to expand...

{
   name: string
   processInputId: integer
   widgets: [
     string
   ]
   defaultValue: string
   options: [
     string
   ]
   description: string
   required: boolean
}

ProductTypeCategoryGroup

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   productTypeId: string
   categoryGroupId: string
   associateCategories: boolean
}

Providers

Click here to expand...

{
}

ProvisioningTimeMetric

Click here to expand...

Discriminator: type

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   description: string
   value: integer
   timeUnit: string
   Enum: [
     "MIN",
     "HOUR",
     "DAY"
   ]
}

QualificationExpression

Click here to expand...

{
   withParentheses: boolean
}

Quantity

Click here to expand...

{
   min: integer
   max: integer
   enabled: boolean
}

QuestionAndAnswer

Click here to expand...

{
   questionnaireId: string
   questionId: string
   questionType: string
   label: string
   options: [
      #QuestionOption
   ]
   answers: [
     string
   ]
   metadata: [
      #AttachmentMetaData
   ]
}

QuestionAnswer

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   QuestionnaireId: string
   The questionnaire ID, provided the question belongs to a questionnaire (value is auto-generated).
    Example: 12803

   Questionn Id: string*
   The question ID for the question being answered.
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   serviceRequestId: string
   The service request ID
    Example: 40597

   displayValueOfAnswers: [
     A list of answer display values corresponding to *answers* entries

     string
   ]

   answers: [
     A list of acceptable answers for the question identified by *questionId*. Please note that multiple answers for a single question are typically only relevant for multiple-choice questions

     string
   ]*
}

QuestionOption

Click here to expand...

{
   dataValue: string
   displayValue: string
   disabled: boolean
}

Questionnaire

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceRevisionId: string
   workflowId: string
   workflow id
    Example: rx-9c67962d-6de5-45c4-b87c-6825e6cdeb19

   questionnaireGroupId: string
   Questionnaire Group Id
    Example: 9f111d32-2ac3-4e48-b162-7224ca41ec4e

   name: string
   Questionnaire name
    Example: This is an example.

   bulkRequestedForUserLimit: integer
   Gets the maximum number of users possible for current bulk order request
    Example: 1

   pages: [
     number of the pages

      #PageWidget
   ]

   actions: [
     a list of actions

      #Action
   ]

   showActions: boolean
   showActions or not
    Example: false

   useDefaultLanguage: boolean
   if use Default Language
    Example: true
}

QuestionnaireCopyDto

Click here to expand...

{
   originWorkflowId: string
}

QuestionnaireDTO

Click here to expand...

{
   questionnaire: #Questionnaire
   questionnaire
}

QuestionnaireDefaultVariable

Click here to expand...

{
   name: string
   expression: string
   iso8601DateTime: boolean
}

QuestionnaireItemChange

Click here to expand...

QuestionnairePaginationDTO

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   questionnaireList: [
      #QuestionnaireDTO
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

QuestionnairesDto

Click here to expand...

{
   questionnaireMap: {
   }
}

RadioButtons

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   options: [
      #QuestionOption
   ]
   connectorId: string
   datasetId: string
   datasetName: string
   datasetIdFieldId: string
   datasetIdFieldName: string
   datasetNameFieldId: string
   datasetNameFieldName: string
   qualification: string
   qualificationExpression: #QualificationExpression
   useCustomQualification: boolean
   defaultAnswer: string
}

RelativeLimit

Click here to expand...

{
   dateUnit: string
   Enum: [
     "DAYS_AGO",
     "WEEKS_AGO",
     "MONTHS_AGO",
     "YEARS_AGO",
     "DAYS_FROM_NOW",
     "WEEKS_FROM_NOW",
     "MONTHS_FROM_NOW",
     "YEARS_FROM_NOW"
   ]
   numberOfUnits: integer
}

RequestCountsByCompany

Click here to expand...

{
   previousCount: integer
   currentCount: integer
   companyName: string
}

RequestError

Click here to expand...

{
   id: string
   The service request error ID
    Example: 1

   message: string
   The error message text
    Example: Failed to create request for aallen with error: "request failure"

   requestedFor: string
   The user ID for which the service had been requested
    Example: hhannah

   type: string
   The error type
   Enum: [
     "ENTITLEMENT_FAILURE",
     "UNCLASSIFIED"
   ]
}

RequestInstance

Click here to expand...

{
   requestId: string
   The service request ID
    Example: 40597

   externalId: string
   The external ID passed by the service's target application (typically a third-party product). For example, if you are requesting access to Microsoft Office365, this is the Office365 ID that is generated in response to your service request
    Example: AGGADG1AANVNMAP3WBQFP2ZF9RT422

   dependencies: [
      #ServiceRequestDependencyDto
   ]
   serviceId: string
   The service revision ID for the request
    Example: 14807
}

RequestMessage

Click here to expand...

{
   messageType: string
   Enum: [
     "ERROR",
     "WARNING",
     "INFO"
   ]
   messageNum: integer
   messageText: string
   bundleId: string
   appendedText: string
}

RequestedServicesByCompanyReport

Click here to expand...

{
   totalCount: integer
   countsByCompany: [
      #RequestCountsByCompany
   ]
}

RequestedServicesBySlaReport

Click here to expand...

{
   serviceName: string
   versionName: string
   serviceType: string
   requestsCount: integer
   provisioningTime: string
   provisioningTimeUnit: string
}

RequestedServicesCategoryReport

Click here to expand...

{
   totalCount: integer
   countByServiceType: [
      #SupplierServiceTypeCount
   ]
}

RevisionFieldValueDto

Click here to expand...

{
   fieldId: string
   values: [
     string
   ]
   locale: string
}

SbCmdbService

Click here to expand...

{
   id: string
   name: string
   description: string
   company: string
   type: string
   Enum: [
     "BUSINESS",
     "TECHNICAL"
   ]
   serviceOfferings: [
      #SbCmdbServiceOffering
   ]
}

SbCmdbServiceOffering

Click here to expand...

{
   id: string
   name: string
   description: string
   defaultSO: boolean
}

SbCmdbServices

Click here to expand...

{
   businessServices: [
      #SbCmdbService
   ]
   technicalServices: [
      #SbCmdbService
   ]
}

SbeBundleService

Click here to expand...

{
   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceVersionId: string
   optional: boolean
   quantity: integer
   preselected: boolean
}

SbeBundleState

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   profileReviewState: string
   Enum: [
     "NEW",
     "REVIEWED",
     "REQUIRED_REVIEW"
   ]
   workflowReviewState: string
   Enum: [
     "NEW",
     "REVIEWED",
     "REQUIRED_REVIEW"
   ]
   questionnaireReviewState: string
   Enum: [
     "NEW",
     "REVIEWED",
     "REQUIRED_REVIEW"
   ]
   slaReviewState: string
   Enum: [
     "NEW",
     "REVIEWED",
     "REQUIRED_REVIEW"
   ]
   costAdjReviewState: string
   Enum: [
     "NEW",
     "REVIEWED",
     "REQUIRED_REVIEW"
   ]
}

SbeCategory

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   categoryGroupId: string
   parentId: string
   childCount: integer
   subCategories: [
      #SbeCategory
   ]
   useDefaultLanguage: boolean
}

SbeCategoryGroup

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   description: string
   systemId: string
   groupStatus: string
   Enum: [
     "ACTIVE",
     "INACTIVE"
   ]
   childCount: integer
   categories: [
      #SbeCategory
   ]
}

SbeDocument

Click here to expand...

{
   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   documentTypeId: string
   url: string
   attachmentName: string
   attachmentUid: string
   loginRequired: boolean
   fileType: string
   size: string
   attachmentContentId: string
}

SbeRevisionMedia

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   mediumId: string
   position: integer
   locale: string
}

SbeSearchCategorization

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   categoryId: string
   categorizableId: string
   categorizableType: string
   externalCategoryId: string
   connectorId: string
}

SbeSearchTag

Click here to expand...

{
   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
}

SbeService

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   state: string
   serviceTypeId: string
   serviceType: #SbeServiceType
   The service template for the service

   versions: [
      #SbeServiceVersion
   ]
   externalId: string
   catalogId: string
   isAction: boolean
   subCatalogId: string
   translations: [
     The view translation in other languages

      #ServiceTranslation
   ]
}

SbeServiceBasicView

Click here to expand...

{
   name: string
   id: string
}

SbeServiceDocument

Click here to expand...

{
   id: string
   name: string
   documentType: string
   documentTypeId: string
   url: string
   attachmentName: string
   fileType: string
   attachmentUrl: string
   size: integer
}

SbeServiceImportPreview

Click here to expand...

{
   name: string
   title: string
   type: string
   Enum: [
     "UNDEFINED",
     "CHECKBOX",
     "DROPDOWN",
     "RADIO",
     "SINGLELINE_INPUT",
     "MULTILINE_INPUT",
     "RICH_INPUT",
     "MEDIA_CAROUSEL",
     "RESOURCES",
     "UNUSED",
     "CONNECTOR"
   ]
   value: string
}

SbeServiceImportStatus

Click here to expand...

{
   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   serviceTypeId: string
   importMapping: [
      #ImportServiceTypeDataMapping
   ]
   selectedForImport: boolean
   importStatus: string
   Enum: [
     "READY_TO_IMPORT",
     "PARTIALLY_IMPORTED",
     "IMPORTED",
     "NEED_TO_UPDATE",
     "IN_PROGRESS",
     "ERROR"
   ]
   workflowId: string
   questionnaireGroupId: string
   overwriteMetadata: boolean
   lastImportedDate: date-time
   allowAttachWorkflow: boolean
   connectorHashCode: string
   sourceLastModifiedDate: date-time
   workflowName: string
   questionnaireId: string
   questionnaireName: string
   companyName: string
   id: string
}

SbeServiceImportStatusPaginationDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   services: [
      #SbeServiceImportStatus
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1

   totalImported: integer
   totalQueued: integer
}

SbeServicePrice

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   paymentType: string
   price: number
   currency: string
   paymentSchedule: string
   useBundledServicesCosts: boolean
   freeLabelId: string
   freeLabel: #Label
}

SbeServiceRevision

Click here to expand...

{
   id: string
   Revision Id
    Example: 16529

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   Revision name
    Example: Euro Currency

   state: string
   Revision state
    Example: approved

   logoId: string
   serviceTypeId: string
   connectorId: string
   workflowId: string
    Example: rx-a3b3b0b3-ef69-4ee7-b8e6-af9e295cde70
   fulfillmentUrl: string
   fulfillmentExternalEmbeddedSupported: boolean
   fulfillmentType: string
   Enum: [
     "INTERNAL_WORKFLOW",
     "EXTERNAL_LINK",
     "EXTERNAL_EMBEDDED"
   ]
   questionnaireGroupId: string
   prices: [
      #SbeServicePrice
   ]
   fieldValues: [
      #SbeServiceTypeFieldValue
   ]
   tags: [
      #SbeSearchTag
   ]
   documents: [
      #SbeDocument
   ]
   allMappedCategories: [
      #SbeSearchCategorization
   ]
   media: [
      #SbeRevisionMedia
   ]
   categoryIds: [
     string
   ]
   multiRequestBundle: boolean
   minQuantity: integer
   maxQuantity: integer
   enableBundleServiceLevelQuantity: boolean
   enableQuantity: boolean
   unavailableRequiredServicesCount: integer
}

SbeServiceType

Click here to expand...

{
   id: string
   The template Id
    Example: 2

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   The name of the template
    Example: Desktop

   fields: [
      #SbeServiceTypeField
   ]
   categories: [
     string
   ]
   productsCount: integer
   enableQuantity: boolean
   deactivated: boolean
   productTypeCategoryGroups: [
      #ProductTypeCategoryGroup
   ]
   publishedRevisionsCount: integer
   parentCategories: {
   }
   templateType: string
   The template type
   Enum: [
     "SERVICE",
     "BUNDLE",
     "CONNECTOR",
     "DAY_2_ACTION"
   ]
    Example: SERVICE
}

SbeServiceTypeField

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   type: string
   Enum: [
     "UNDEFINED",
     "CHECKBOX",
     "DROPDOWN",
     "RADIO",
     "SINGLELINE_INPUT",
     "MULTILINE_INPUT",
     "RICH_INPUT",
     "MEDIA_CAROUSEL",
     "RESOURCES",
     "UNUSED",
     "CONNECTOR"
   ]
   title: string
   required: boolean
   position: integer
   params: {
   }
   fieldsLocalization: {
   }
}

SbeServiceTypeFieldTranslation

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   typeFieldId: string
   title: string
   paramsLocaleText: {
   }
   locale: string
   useDefaultLanguage: boolean
}

SbeServiceTypeFieldValue

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceTypeFieldId: string
   value: [
     string
   ]
   locale: string
}

SbeServiceVersion

Click here to expand...

{
   id: string
   View Id

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
    Example: 2018-10-02T21:27:47.000+0000
   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   View name

   revisions: [
      #SbeServiceRevision
   ]
   state: string
   version: string
   available: boolean
   day2ActionRevisionId: string
   quickRequest: boolean
   description: string
   excerpt: string
   iconUrl: string
   rating: number
   createdDate: date-time
   ratingCount: integer
   workflowId: string
   categories: [
      #SbeCategory
   ]
   price: #Price
   onceCost: number
   monthlyCost: number
   yearlyCost: number
   provisioningTime: #ProvisioningTimeMetric
   dynamicFields: [
      #DynamicField
   ]
   serviceType: string
   externalId: string
   externalWorkflow: string
   Enum: [
     "SRM",
     "CLM",
     "LINK",
     "OTHER"
   ]
   templateType: string
   Enum: [
     "SERVICE",
     "BUNDLE",
     "CONNECTOR",
     "DAY_2_ACTION"
   ]
   bundledServices: [
      #SbeServiceVersion
   ]
   entitled: boolean
   fulfillmentUrl: string
   fulfillmentType: string
   media: [
      #ServiceMedia
   ]
   multiRequestBundle: boolean
   quantity: #Quantity
   bundleOptional: boolean
   restrictedFullCatalogView: boolean
   publisher: string
   useBundledServicesCosts: boolean
   bundleOptionalIncluded: boolean
   score: integer
   bulkRequestedForUserLimit: integer
   unavailableRequiredServicesCount: integer
   translations: [
      #ServiceVersionTranslation
   ]
   subCatalogId: string
   dependencies: [
      #DependedEntity
   ]
   calculatedAvailability: boolean
   isDependent: boolean
}

SbeServiceVersionBasicView

Click here to expand...

{
   name: string
   View name

   id: string
   View Id

   serviceId: string
   Service id

   quickRequest: boolean
}

SbeServiceVersionPaginationDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   services: [
      #SbeServiceVersion
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

SearchCriteriaVmBanner

Click here to expand...

{
   page: integer
   pageSize: integer
   vmId: string
   bannerNameLike: string
   bannerIds: [
     string
   ]
   bannerNameOrder: string
   Enum: [
     "ASC",
     "DESC"
   ]
   userId: string
   paginated: boolean
}

SearchCriteriaVmGroup

Click here to expand...

{
   page: integer
   pageSize: integer
   vmId: string
   fullNameLike: string
   getSelectedOnly: boolean
   fullNameOrder: string
   Enum: [
     "ASC",
     "DESC"
   ]
   paginated: boolean
}

SearchCriteriaVmMember

Click here to expand...

{
   page: integer
   pageSize: integer
   vmId: string
   fullNameLike: string
   loginNames: [
     string
   ]
   fullNameOrder: string
   Enum: [
     "ASC",
     "DESC"
   ]
   paginated: boolean
}

SearchCriteriaVmService

Click here to expand...

{
   page: integer
   pageSize: integer
   vmId: string
   serviceNameLike: string
   serviceIDs: [
     string
   ]
   serviceNameOrder: string
   Enum: [
     "ASC",
     "DESC"
   ]
   userId: string
   categoryIds: [
     string
   ]
   subCatalogId: string
   paginated: boolean
}

SearchResult

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   resultItems: [
     Lists the results

      {
     }
   ]

   total: integer
   The total number of matching records for the current query
    Example: 1
}

SearchResultForDay2Action

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   resultItems: [
     Lists the results

      #SearchResultItemDay2ActionService
   ]

   total: integer
   The total number of matching records for the current query
    Example: 1
}

SearchResultItemDay2ActionService

Click here to expand...

{
   revisionId: string
   service revision id
    Example: 14807

   revisionName: string
   service revision name
    Example: Testing action

   revisionState: string
   Service revision state, approve, pushlished...
    Example: published

   revisionUpdatedAt: date-time
   update date
    Example: 2018-09-28T18:41:44.000+0000

   revisionLogoUri: string
   logo url if any
    Example: null

   versionId: string
   service version id
    Example: 14811

   versionName: string
   service version name
    Example: V1

   serviceId: string
   service version id
    Example: 14411

   day2ActionStatus: string
   action status, Active or Inactive
    Example: Active
}

SearchSBEServiceDto

Click here to expand...

{
   serviceIds: [
     string
   ]
   title: string
   categoryId: string
   categoryIds: [
     string
   ]
   entitledOnly: boolean
   restrictedOnly: boolean
   currentUserSubCatalogOnly: boolean
   excludeTemplateTypes: [
     string
     Enum: [
       "SERVICE",
       "BUNDLE",
       "CONNECTOR",
       "DAY_2_ACTION"
     ]
   ]
   questionnaireIds: [
     string
   ]
   subCatalogIds: [
     string
   ]
   ignoreEntitlements: boolean
}

SectionWidget

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   title: string
}

ServiceCostQuantityDto

Click here to expand...

{
   quantity: #Quantity
   costAdjustment: #CostAdjustment
   price: #SbeServicePrice
   enableBundleServiceLevelQuantity: boolean
   bundleServicesCostQuantity: [
      #BundleServiceCostQuantityDto
   ]
}

ServiceCostReport

Click here to expand...

{
   serviceName: string
   version: string
   serviceType: string
   count: integer
   totalCost: number
}

ServiceCostReportDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   data: [
      #ServiceCostReport
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

ServiceCreationDto

Click here to expand...

{
   name: string
   templateId: string
   version: string
   workflowId: string
   questionnaireGroupId: string
   quickRequest: boolean
   unavailableRequiredServicesCount: integer
   subCatalogId: string
   bundle: boolean
}

ServiceDependencyDto

Click here to expand...

{
   dependencyId: string
   dependedEntityId: string
   dependedEntityName: string
   dependencyType: string
   Enum: [
     "SERVICE_VERSION"
   ]
   mappings: [
      #ServiceDependencyMappingDto
   ]
}

ServiceDependencyMappingDto

Click here to expand...

{
   sourcePropertyName: string
   targetPropertyName: string
}

ServiceMedia

Click here to expand...

{
   type: string
   Enum: [
     "IMAGE",
     "VIDEO"
   ]
   url: string
}

ServiceMediaDto

Click here to expand...

{
   id: string
   position: integer
   full: string
   preview: string
   videoDescription: string
   videoId: string
   locale: string
}

ServiceOrder

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   title: string
   expectedDate: date-time
   requests: [
     A list of service request objects

      #ServiceRequest
   ]*

   requestForUserIds: [
     A list of user IDs representing users for whom the order is being placed

     string
   ]

   connectorIdExternalOrderIdPairs: [
     A list of *connectorId-externalOrderId* pairs.

      #ConnectorIdExternalOrderIdPair
   ]*

   serviceIds: [
     A list of service revision IDs identifying the services included in the order

     string
   ]
}

ServiceQuestionnaireDto

Click here to expand...

{
   id: string
   questionnaireGroupId: string
}

ServiceRating

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   date: date-time
   serviceId: string
   userId: string
   rating: double
}

ServiceRatingPaginationDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   ratings: [
      #ServiceRating
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

ServiceReimportDTO

Click here to expand...

{
   reimportCount: integer
}

ServiceRequest

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceId: string
   processName: string
    Example: myit-sb:DEMO_Create Case
   processInstanceId: string
    Example: IDGADGG8ECDC0AP6ANV3P6ANV3V0JW
   requestingUserId: string
    Example: Allen
   requestForUserId: string
    Example: Peter
   serviceRevisionId: string
    Example: 11025
   requestState: string
   Enum: [
     "NEW",
     "ACTIVE",
     "COMPLETED",
     "UNKNOWN",
     "SUSPENDED",
     "FAILED",
     "WAITING_FOR_APPROVAL",
     "APPROVED",
     "REJECTED",
     "CANCELLED",
     "CLOSED",
     "PENDING"
   ]
   workflowStartTime: date-time
   workflowLastModifiedTime: date-time
   workflowCompleteTime: date-time
   errorDetails: string
   quantity: integer
   bundleVersionId: string
   orderId: string
   bundleRequestId: string
   bundleQuantity: integer
   myStuffItemId: string
   myStuffItemName: string
   bulkRequestMasterId: string
   isBulkRequestMaster: boolean
   collaboratorId: string
   companyId: string
   bundleName: string
   expectedDate: date-time
   existingRequest: boolean
   bulkRequestChild: boolean
   submittedDate: date-time
}

ServiceRequestCollaboratorDto

Click here to expand...

{
   userIds: [
     string
   ]
   userFullNames: [
     string
   ]
}

ServiceRequestCreationDTO

Click here to expand...

{
   serviceId: string*
   The service revision ID used to identify the request
    Example: 14807

   requestForUserIds: [
     A list of user IDs for which the service is requested. We recommend that you limit the number of users per request to 20

     string
   ]

   excludedServiceIds: [
     A list of service revision IDs that will be excluded from the request bundle

     string
   ]

   dependencies: [
      #ServiceRequestDependencyDto
   ]
   quantity: integer
   The service request quantity
    Example: 1

   referenceRequestId: string
   A prior request ID, if relevant
    Example: 5678

   myStuffItemId: string
   The My Stuff item ID, provided the service request is for a Day 2 action
    Example: 9012

   onBehalfOfUserId: string
   The user ID on behalf of which the service request is being made
    Example: 9012

   questions: [
     A list of common answers for relevant service request questions. Please note that this field (array) is optional; however, if you choose to include it in your payload, you must provide at least the *questionId* and the associated answer. If your service request is for multiple users, they all must have provided the same answer

      #QuestionAnswer
   ]
}

ServiceRequestCreationResponse

Click here to expand...

{
   serviceId: string
   The service revision id
    Example: 14807

   bundleRequestId: string
   The service bundle Request Id
    Example: 12345

   Requests: [
     A list of service request instances

      #RequestInstance
   ]

   requestErrors: [
     A list of service request errors (this will only be returned if the call failed or was partially successful)

      #RequestError
   ]
}

ServiceRequestDTO

Click here to expand...

{
   requestId: string
   externalId: string
   questionnaire: string
   onStartChanges: {
   }
   serviceId: string
}

ServiceRequestDependencyDto

Click here to expand...

{
   serviceRequestId: string
}

ServiceRequestDetails

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceId: string
   processName: string
    Example: myit-sb:DEMO_Create Case
   processInstanceId: string
    Example: IDGADGG8ECDC0AP6ANV3P6ANV3V0JW
   requestingUserId: string
    Example: Allen
   requestForUserId: string
    Example: Peter
   serviceRevisionId: string
    Example: 11025
   requestState: string
   Enum: [
     "NEW",
     "ACTIVE",
     "COMPLETED",
     "UNKNOWN",
     "SUSPENDED",
     "FAILED",
     "WAITING_FOR_APPROVAL",
     "APPROVED",
     "REJECTED",
     "CANCELLED",
     "CLOSED",
     "PENDING"
   ]
   workflowStartTime: date-time
   workflowLastModifiedTime: date-time
   workflowCompleteTime: date-time
   errorDetails: string
   quantity: integer
   orderId: string
   bundleRequestId: string
   bundleQuantity: integer
   myStuffItemId: string
   myStuffItemName: string
   bulkRequestMasterId: string
   isBulkRequestMaster: boolean
   collaboratorId: string
   companyId: string
   bundleName: string
   expectedDate: date-time
   existingRequest: boolean
   name: string
   description: string
   excerpt: string
   price: #Price
   status: #ServiceRequestStatus
   provisioningTime: #ProvisioningTimeMetric
   logoUrl: string
   onceCost: number
   monthlyCost: number
   yearlyCost: number
   externalActivities: [
      #ExternalActivityInServiceRequestDetail
   ]
   canRequestAgain: boolean
   orderTitle: string
   concealFromEndUser: boolean
   requestingUserFullName: string
   requestForUserFullName: string
   requestingUserEmail: string
   requestForUserEmail: string
   versionName: string
   serviceName: string
   revisionId: string
   myStuffItem: #MyStuffItemDetails
   socialActivities: [
      #ActivityLogDetails
   ]
   answers: [
      #QuestionAndAnswer
   ]
   collaborators: #ServiceRequestCollaboratorDto
   userCollaboratorPreference: #UserPreferenceDto
   collaboratorsDisabled: boolean
   quickRequest: boolean
   displayId: string
   companyName: string
   bulkRequestChild: boolean
   bundleId: string
   submittedDate: date-time
}

ServiceRequestDetailsRequest

Click here to expand...

{
   since: date-time
   dateTo: date-time
   currentUserLogin: string
   requestedFor: string
   requestedBy: string
   max: integer
   requestIds: [
     string
   ]
   orderId: string
   search: string
   sortBy: string
   sortDirection: string
   pageSize: integer
   page: integer
   ignoreStatus: boolean
   showCanRequestAgain: boolean
   includeActivityLogs: boolean
   includeAnswers: boolean
   statuses: [
     string
   ]
   withUserInfo: boolean
   subCatalogIds: [
     string
   ]
   currentUserSubCatalogOnly: boolean
   sinceStatusChange: date-time
   dependencyId: string
   dependencyType: string
   Enum: [
     "SERVICE_VERSION"
   ]
   companyIds: [
     string
   ]
}

ServiceRequestExternalActivityCriteria

Click here to expand...

{
   externalActivityIds: [
     string
   ]
}

ServiceRequestStatus

Click here to expand...

{
   id: string
   serviceId: string
   status: string
   Enum: [
     "NEW",
     "ACTIVE",
     "COMPLETED",
     "UNKNOWN",
     "SUSPENDED",
     "FAILED",
     "WAITING_FOR_APPROVAL",
     "APPROVED",
     "REJECTED",
     "CANCELLED",
     "CLOSED",
     "PENDING"
   ]
   subStatus: string
   statusReason: string
   startTime: date-time
   lastModifiedTime: date-time
   completeTime: date-time
}

ServiceRequestUpdateDto

Click here to expand...

{
   id: string
   requestForUserIds: [
     string
   ]
   quantity: integer
   collaborators: #ServiceRequestCollaboratorDto
   allBundledServiceVersionIds: [
     string
   ]
}

ServiceRequestUpdateResponse

Click here to expand...

{
   serviceId: string
   bundleRequestId: string
   requests: [
      #ServiceRequestDTO
   ]
   requestErrors: [
      #RequestError
   ]
}

ServiceReview

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceId: string
   userId: string
   title: string
   content: string
}

ServiceReviewPaginationDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   reviews: [
      #ServiceReview
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

ServiceRevisionProfileDto

Click here to expand...

{
   id: string
   fulfillmentType: string
   Enum: [
     "INTERNAL_WORKFLOW",
     "EXTERNAL_LINK",
     "EXTERNAL_EMBEDDED"
   ]
   fulfillmentExternalEmbeddedSupported: boolean
   fulfillmentUrl: string
   connectorId: string
   logo: #LogoWithUrlDto
   tags: [
     string
   ]
   documents: [
      #SbeServiceDocument
   ]
   categories: [
     string
   ]
   media: [
      #ServiceMediaDto
   ]
   values: [
      #RevisionFieldValueDto
   ]
   serviceTemplate: #SbeServiceType
   useDefaultLanguage: boolean
   useDefaultMedia: boolean
   useDefaultDocuments: boolean
   useDefaultTags: boolean
   quickRequest: boolean
}

ServiceSelectionBatchUpdate

Click here to expand...

{
   categoryIds: [
     string
   ]
   serviceIds: [
     string
   ]
   workflowId: string
   workflowName: string
   serviceTypeId: string
   questionnaireId: string
   questionnaireName: string
   questionnaireGroupId: string
   importMapping: [
      #ImportServiceTypeDataMapping
   ]
}

ServiceTemplateFieldsDTO

Click here to expand...

{
   defaultFields: [
      #DefaultField
   ]
   fieldTypeChoices: [
      #FieldTypeChoice
   ]
}

ServiceTemplateListDTO

Click here to expand...

{
   id: string
   name: string
   modifiedDate: date-time
   serviceCount: integer
   deactivated: boolean
   templateType: string
   Enum: [
     "SERVICE",
     "BUNDLE",
     "CONNECTOR",
     "DAY_2_ACTION"
   ]
}

ServiceTemplateListPaginationDTO

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   data: [
      #ServiceTemplateListDTO
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

ServiceTranslation

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   Service name in other language
    Example: name in French

   serviceId: string
   Service Id
    Example: 1223

   locale: string
   locale
    Example: en

   useDefaultLanguage: boolean
}

ServiceVersionDependencySearchDto

Click here to expand...

{
   categoryIds: [
     string
   ]
}

ServiceVersionTranslation

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   Service version name in other language
    Example: name in French

   serviceVersionId: string
   Service version id
    Example: 12345

   locale: string
   locale
    Example: en
}

ServiceVersionWithRevisionsView

Click here to expand...

{
   name: string
   View name

   id: string
   Service version id

   revisions: [
      #BasicRevisionView
   ]
   available: boolean
   createDate: date-time
    Example: 2018-10-02T21:27:47.000+0000
   quickRequest: boolean
   dependent: boolean
   translations: [
      #ServiceVersionTranslation
   ]
}

ServiceWithVersionsView

Click here to expand...

{
   name: string
   id: string
   versions: [
      #ServiceVersionWithRevisionsView
   ]
   serviceType: #BasicServiceTemplateView
   The service template for the service

   translations: [
     The view translation in other languages

      #ServiceTranslation
   ]
}

ServicesDay2ActionsCountDto

Click here to expand...

{
   day2ActionsAttachedTo: integer
   The number of services that the Day 2 action is attached to
    Example: 1
}

Site

Click here to expand...

{
   name: string
   country: string
   stateProvince: string
   city: string
   zipPostalCode: string
   street: string
}

Sla

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceRevisionId: string
   description: string
   files: [
      #SlaFile
   ]
   links: [
      #SlaLink
   ]
   metrics: [
      #Metric
   ]
}

SlaFile

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   fileId: string
}

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   link: string
}

SlaResource

Click here to expand...

{
}

StackTraceElement

Click here to expand...

{
   methodName: string
   fileName: string
   lineNumber: integer
   className: string
   nativeMethod: boolean
}

StreamingOutput

Click here to expand...

{
}

SubCatalog

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   externalSubCatalogId: string
   activityTypeLabel: string
   activityTemplateLabel: string
   connectionId: string
}

SubCatalogDTO

Click here to expand...

{
   id: string
   name: string
   serviceCount: integer
   day2actionCount: integer
   adminCount: integer
   supplierCount: integer
}

SubCatalogPaginationDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   data: [
      #SubCatalog
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

SubTenantDto

Click here to expand...

{
   id: string
   name: string
   companyId: string
   modifiedDate: date-time
   servicesCount: integer
}

SubTenantsDto

Click here to expand...

{
   subTenants: [
      #SubTenantDto
   ]
}

SupplierServiceTypeCount

Click here to expand...

{
   previousCount: integer
   currentCount: integer
   supplierId: string
   supplierName: string
   supplierLogo: string
   serviceTypeId: string
   serviceTypeName: string
}

SupportResponseMetric

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   description: string
   lowSeverityTime: integer
   lowSeverityUnit: string
   Enum: [
     "MIN",
     "HOUR",
     "DAY"
   ]
   mediumSeverityTime: integer
   mediumSeverityUnit: string
   Enum: [
     "MIN",
     "HOUR",
     "DAY"
   ]
   highSeverityTime: integer
   highSeverityUnit: string
   Enum: [
     "MIN",
     "HOUR",
     "DAY"
   ]
   criticalSeverityTime: integer
   criticalSeverityUnit: string
   Enum: [
     "MIN",
     "HOUR",
     "DAY"
   ]
}

TableMapping

Click here to expand...

{
   connectorId: string
   Connector Id
    Example: 1

   tableId: string
   Table Id
    Example: DATASET ID

   tableName: string
   table Name
    Example: DATASET NAME

   mappings: [
     a list of FieldMapping

      #FieldMapping
   ]

   qualification: #QualificationExpression
   QualificationExpression
}

TenantConfigurationDTO

Click here to expand...

{
   prefillSimilarQuestions: boolean
   multiLanguage: boolean
   quickRequest: boolean
   itsmConnectionId: string
   cmdbConnectionId: string
   chatbotUrl: string
   bulkRequestedForUserLimit: integer
   searchRequestAnswers: boolean
   enableRcf: boolean
   chatbotRssoUrl: string
   hasChatbotCrossSsoPrivateKey: boolean
   chatbotCrossSsoPrivateKey: string
   chatbotCrossSsoPrivateKeyPassphrase: string
}

TextArea

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   defaultAnswer: string
   formattingHint: string
   maxLength: integer
   regex: string
   numberOfRows: integer
}

TextField

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   defaultAnswer: string
   maxLength: integer
   regex: string
   formattingHint: string
}

Throwable

Click here to expand...

{
   cause: #Throwable
   stackTrace: [
      #StackTraceElement
   ]
   message: string
   localizedMessage: string
   suppressed: [
      #Throwable
   ]
}

TimeField

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   defaultAnswer: string
}

TimezoneDetails

Click here to expand...

{
   timezoneId: string
   timezoneName: string
   offset: string
}

TypedDataPage

Click here to expand...

{
   totalSize: integer
   data: [
      {
     }
   ]
   empty: boolean
}

UpdateNotificationDto

Click here to expand...

{
   updateMode: string
   Enum: [
     "READ",
     "DISMISS"
   ]
   notificationIds: [
     string
   ]
}

User

Click here to expand...

{
   fullName: string
   loginName: string
   password: string
   userId: string
   emailAddress: string
   groups: [
     string
   ]
   computedGroups: [
     string
   ]
   licenseType: string
   defaultNotifyMechanism: string
   forcePasswordChangeOnLogin: boolean
   createdBy: string
   permittedGroupsBySecurityLabels: {
   }
   permittedUsersBySecurityLabels: {
   }
   allowedClientTypes: string
   applicationLicense: string
   disablePasswordManagementForUser: boolean
   numDaysBeforeExpiration: integer
   numWarningDays: integer
   daysAfterExpirationUntilDisablement: integer
   lastPasswordChange: date-time
   acctountDisabledDate: date-time
   defaultOverlayGroupId: string
   userOverlayGroupDescriptors: [
      #UserOverlayGroupDescriptor
   ]
}

UserDTO

Click here to expand...

{
   id: string
   fullName: string
   password: string
   groups: [
     string
   ]
}

UserGroupAssignmentDTO

Click here to expand...

{
   loginName: string
   groupName: string
}

UserOverlayGroupDescriptor

Click here to expand...

{
   overlayGroupId: string
   overlayGroupName: string
   tenantId: string
   tenantName: string
   userOverlayGroupDescriptorChildren: [
      #UserOverlayGroupDescriptor
   ]
   isWritable: boolean
}

UserPreferenceDto

Click here to expand...

{
   favouriteServiceRequestCollaborators: [
      #ServiceRequestCollaboratorDto
   ]
   serviceRequestCollaboratorRuleAutoload: boolean
}

UserSearch

Click here to expand...

{
   terms: [
      #UserSearchTerm
   ]
}

UserSearchResultDto

Click here to expand...

{
   users: [
      #Person
   ]
   pageSize: integer
   page: integer
   total: integer
}

UserSearchTerm

Click here to expand...

{
   criteriaId: string
   criteriaName: string
   operator: string
   Enum: [
     "EQUAL",
     "LIKE",
     "IN"
   ]
   valueId: string
   valueName: string
   path: string
}

VirtualMarketplace

Click here to expand...

{
   ID: string
   id
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   guid: string
   GUID
    Example: AGGADGG8ECDC0AP5X5L1P5A76XAIJO

   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   name: string
   userCount: integer
   adminCount: integer
   userSearch: #UserSearch
   peopleIncluded: [
     string
   ]
   serviceCount: integer
   groupCount: integer
   bannerCount: integer
   attributeCount: integer
   userIDs: [
     string
   ]
   adminIDs: [
     string
   ]
   groupIDs: [
     string
   ]
   serviceIDs: [
     string
   ]
   bannerIDs: [
     string
   ]
   entitleEveryone: boolean
   subCatalogId: string
   subCatalogName: string
}

VirtualMarketplaceRestrictedService

Click here to expand...

{
   createDate: date-time
   When the record was created
    Example: 2018-09-27T18:37:18.000+0000

   modifiedDate: date-time
   When the record was last modified
    Example: 2018-09-27T18:37:18.000+0000

   rxId: string
   The request identifier in the server database (value is auto-generated)
    Example: 1

   serviceId: string
   restrictedDate: date-time
   restrictedBy: string
   name: string
   version: string
   template: string
   subCatalogId: string
}

VirtualMarketplaceRestrictedServicePaginationDto

Click here to expand...

{
   pageSize: integer
   The number of records included in the current page in the result set for the current query
    Example: 20

   page: integer
   The order of the current page in the result set for the current query
    Example: 1

   services: [
      #VirtualMarketplaceRestrictedService
   ]
   total: integer
   The total number of matching records for the current query
    Example: 1
}

VisibilityChange

Click here to expand...

{
   visible: boolean
}

YesNo

Click here to expand...

{
   id: string
   id
    Example: 97f8a510-4281-f441-888b-682eaf7c340e

   externalId: string
   external id
    Example: null

   perUser: boolean
   perUser or not
    Example: false

   visible: boolean
   useDefaultLocale: boolean
   Use Default Locale or not
    Example: true

   visibilityCondition: #LeadingQuestionCondition
   visibility Condition

   label: string
   label
    Example: some label

   description: string
   description
    Example: <p>some description</p>

   required: boolean
   if it is a required widget
    Example: false

   template: string
   template
    Example: some template

   processInputId: integer
   Process InputId
    Example: 123

   hidden: boolean
   hidden or not
    Example: false

   readOnly: boolean
   readOnly or not
    Example: false

   answerSource: string
   Answer Source
   Enum: [
     "DEFAULT",
     "PREFILL",
     "SAVED"
   ]
    Example: DEFAULT

   tags: [
     string
   ]
   options: [
      #QuestionOption
   ]
   connectorId: string
   datasetId: string
   datasetName: string
   datasetIdFieldId: string
   datasetIdFieldName: string
   datasetNameFieldId: string
   datasetNameFieldName: string
   qualification: string
   qualificationExpression: #QualificationExpression
   useCustomQualification: boolean
   defaultAnswer: string
}