| |
---|
|
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 }
|
|
Click here to expand...
{ name: string externalActivityFactory: boolean externalActivityModifier: boolean externalActivityType: string actionOutputCaptures: [ #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" ] }
|
|
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 }
|
|
Click here to expand...
{ id: string name: string size: integer mediaType: string }
|
|
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 ] }
|
|
Click here to expand...
{ text: string authorLoginID: string visibility: string broadcast: boolean externalId: string externalExternalActivityId: string externalActivityType: string }
|
| |
| |
|
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 }
|
| |
|
Click here to expand...
{ name: string externalId: string children: [ #AssetClass ] }
|
|
Click here to expand...
{ id: string name: string type: string }
|
| |
|
Click here to expand...
{ externalId: string external id Example: 9717 name: string name of the mapping Example: CreateIncident available: boolean }
|
|
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" ] }
|
|
Click here to expand...
{ modifiedDate: date-time connectionsStatus: string Enum: [ "ALL_CONNECTED", "HAS_NON_CONNECTED" ] name: string id: string }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 ] }
|
|
Click here to expand...
{ id: string logoUrl: string name: string }
|
|
Click here to expand...
{ id: string isAvailable: boolean }
|
|
Click here to expand...
{ id: string name: string type: string Enum: [ "PENDING", "AVAILABLE", "UNAVAILABLE", "RETIRED" ] }
|
|
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: { } }
|
|
Click here to expand...
{ contentId: string fileName: string mimeType: string }
|
|
Click here to expand...
{ inputs: [ string ] outputs: [ 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 description: string uptime: number }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
Click here to expand...
{ timezonesWithOffset: [ #TimezoneDetails ] activationDatetime: string deactivationDatetime: string archiveOnDeactivation: boolean scheduleTimezone: #TimezoneDetails }
|
|
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 }
|
|
Click here to expand...
{ banners: [ #BannerDto ] stateCounts: { } page: integer pageSize: integer total: integer }
|
|
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 }
|
|
Click here to expand...
{ bannerIds: [ string ] state: string }
|
| |
|
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 }
|
|
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...
{ 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 }
|
| |
|
Click here to expand...
{ bundledVersionIds: [ string ] workflowId: string questionnaireGroupId: string multiRequest: boolean }
|
|
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" ] }
|
| |
|
Click here to expand...
{ overwriteMetadata: boolean id: string }
|
|
Click here to expand...
{ categorySelectIds: [ string ] serviceSelectIds: [ string ] categoryDeselectIds: [ string ] serviceDeselectIds: [ string ] }
|
|
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 }
|
|
Click here to expand...
{ id: string name: string }
|
|
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 }
|
|
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 ] }
|
|
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 }
|
|
Click here to expand...
{ id: string name: 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 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 }
|
| |
|
Click here to expand...
{ id: string name: string connectorName: string connectorId: string }
|
|
Click here to expand...
{ name: string type: string Enum: [ "STRING", "PASSWORD", "INTEGER" ] }
|
|
Click here to expand...
{ connectorId: string label: string }
|
|
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 ] }
|
|
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 }
|
|
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 }
|
|
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 ] }
|
| |
|
Click here to expand...
{ name: string version: string rxBundleId: string panamaAppId: string panamaConnectorLowerCaseName: string rcfConnectorType: string configs: [ { } ] id: string }
|
|
Click here to expand...
{ binaryData: [ byte ] fileName: string mediaType: string }
|
|
Click here to expand...
{ type: string parameters: { } fileName: string creationDate: date-time modificationDate: date-time readDate: date-time size: integer }
|
|
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 }
|
|
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 }
|
|
Click here to expand...
{ name: string serviceversionId: string available: boolean serviceVersionId: 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 offsets: [ #CostOffset ] serviceRevisionId: 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 offsets: [ #CostOffset ] serviceRevisionId: string profileName: 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 value: number paymentFrequency: string Enum: [ "ONCE", "MONTHLY", "YEARLY" ] offsetDetails: [ #CostOffsetDetail ] category: #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 category: string value: number }
|
| |
|
Click here to expand...
{ currencyCode: string displayName: string defaultFractionDigits: integer numericCode: integer symbol: string }
|
|
Click here to expand...
{ id: string name: string }
|
|
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 }
|
| |
|
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 }
|
|
Click here to expand...
{ limitType: string Enum: [ "NO_LIMIT", "CURRENT", "SPECIFIC", "RELATIVE" ] specificLimit: string relativeLimit: #RelativeLimit computedLimit: string }
|
|
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 }
|
|
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 }
|
|
Click here to expand...
{ type: string Enum: [ "EXTERNAL_WEB_SITE", "REQUEST", "CONNECTOR" ] name: string The Day 2 action name Example: Demo Day 2 action }
|
| |
|
Click here to expand...
{ connectionId: string name: string state: string showMyStuffItems: boolean allSelected: boolean assetClasses: [ #AssetClassDto ] condition: string conditionName: string }
|
|
Click here to expand...
{ servicesAttachedTo: integer connectionsAttachedTo: integer assetClassesAttachedTo: integer }
|
|
Click here to expand...
{ active: integer inactive: integer }
|
|
Click here to expand...
{ id: string active: boolean }
|
|
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 }
|
| |
| |
|
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 }
|
|
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 }
|
|
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 }
|
| |
|
Click here to expand...
{ entitleEveryone: boolean }
|
|
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 }
|
|
Click here to expand...
{ id: string name: string parentId: string connectorId: string }
|
|
Click here to expand...
{ id: string externalCategoryId: string externalCategoryName: string connectorId: string categoryId: string categoryName: string connectorName: string }
|
|
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 }
|
|
Click here to expand...
{ type: string Enum: [ "UNDEFINED", "CHECKBOX", "DROPDOWN", "RADIO", "SINGLELINE_INPUT", "MULTILINE_INPUT", "RICH_INPUT", "MEDIA_CAROUSEL", "RESOURCES", "UNUSED", "CONNECTOR" ] singleton: boolean }
|
|
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 }
|
| |
FormDataBodyPart | |
|
Click here to expand...
{ type: string parameters: { } fileName: string creationDate: date-time modificationDate: date-time readDate: date-time size: integer name: string }
|
| |
|
Click here to expand...
{ fullCatalogView: boolean }
|
| |
| |
|
Click here to expand...
{ status: string Enum: [ "PASSED", "FAILED", "UNKNOWN" ] enabled: boolean additionalInfo: 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 serviceTypeFieldId: string connectorFieldName: 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 text: string type: string Enum: [ "FREE_SERVICE_TEXT" ] editable: boolean defaultLabel: boolean 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 }
|
|
Click here to expand...
{ leadingQuestionId: string leading Question Id Example: Q1 leadingQuestionExpectedAnswers: [ a list of LeadingQuestionExpectedAnswers string ] expression: #QualificationExpression }
|
|
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 }
|
|
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 }
|
|
Click here to expand...
{ authenticated: boolean sbGroup: string user: #User tenantMode: string Enum: [ "FULL", "LITE" ] integrationService: boolean deploymentType: string Enum: [ "ONCLOUD", "ONPREM" ] }
|
|
Click here to expand...
{ id: string url: string locale: string }
|
|
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 }
|
| |
| |
|
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 }
|
|
Click here to expand...
{ type: string subtype: string parameters: { } wildcardType: boolean wildcardSubtype: boolean }
|
MessageBodyWorkers | |
|
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 }
|
|
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 }
|
| |
|
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 ] }
|
| |
|
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 }
|
|
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 }
|
|
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 ] }
|
|
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 }
|
|
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 }
|
|
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 }
|
| |
| |
|
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 }
|
|
Click here to expand...
{ id: string name: string type: string Enum: [ "UNKNOWN", "PENDING", "AVAILABLE", "FULFILLED", "CANCELLED", "RETIRED" ] }
|
|
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: { } }
|
|
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 }
|
|
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 }
|
|
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 }
|
| |
| |
|
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 ] }
|
|
Click here to expand...
{ value: string parameters: { } }
|
|
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 }
|
|
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 }
|
|
Click here to expand...
{ id: string name: string path: string }
|
|
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 }
|
|
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 }
|
|
Click here to expand...
{ paymentType: string freeLabelText: string price: number currency: string paymentSchedule: string }
|
| |
|
Click here to expand...
{ name: string processInputId: integer widgets: [ string ] defaultValue: string options: [ string ] description: string required: boolean }
|
|
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 }
|
| |
|
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" ] }
|
|
Click here to expand...
{ withParentheses: boolean }
|
|
Click here to expand...
{ min: integer max: integer enabled: boolean }
|
QuestionAndAnswer | |
|
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 ]* }
|
|
Click here to expand...
{ dataValue: string displayValue: string disabled: boolean }
|
|
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 }
|
|
Click here to expand...
{ originWorkflowId: string }
|
| |
|
Click here to expand...
{ name: string expression: string iso8601DateTime: boolean }
|
| |
|
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 }
|
| |
|
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 }
|
|
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 }
|
|
Click here to expand...
{ previousCount: integer currentCount: integer companyName: string }
|
|
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" ] }
|
|
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 }
|
|
Click here to expand...
{ messageType: string Enum: [ "ERROR", "WARNING", "INFO" ] messageNum: integer messageText: string bundleId: string appendedText: string }
|
| |
|
Click here to expand...
{ serviceName: string versionName: string serviceType: string requestsCount: integer provisioningTime: string provisioningTimeUnit: string }
|
| |
|
Click here to expand...
{ fieldId: string values: [ string ] locale: string }
|
|
Click here to expand...
{ id: string name: string description: string company: string type: string Enum: [ "BUSINESS", "TECHNICAL" ] serviceOfferings: [ #SbCmdbServiceOffering ] }
|
|
Click here to expand...
{ id: string name: string description: string defaultSO: boolean }
|
| |
|
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 }
|
|
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" ] }
|
|
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 }
|
|
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 ] }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 ] }
|
|
Click here to expand...
{ name: string id: string }
|
|
Click here to expand...
{ id: string name: string documentType: string documentTypeId: string url: string attachmentName: string fileType: string attachmentUrl: string size: integer }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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: { } }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
Click here to expand...
{ name: string View name id: string View Id serviceId: string Service id quickRequest: boolean }
|
|
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 }
|
|
Click here to expand...
{ page: integer pageSize: integer vmId: string bannerNameLike: string bannerIds: [ string ] bannerNameOrder: string Enum: [ "ASC", "DESC" ] userId: string paginated: boolean }
|
|
Click here to expand...
{ page: integer pageSize: integer vmId: string fullNameLike: string getSelectedOnly: boolean fullNameOrder: string Enum: [ "ASC", "DESC" ] paginated: boolean }
|
|
Click here to expand...
{ page: integer pageSize: integer vmId: string fullNameLike: string loginNames: [ string ] fullNameOrder: string Enum: [ "ASC", "DESC" ] paginated: boolean }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 }
|
| |
|
Click here to expand...
{ serviceName: string version: string serviceType: string count: integer totalCost: number }
|
|
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 }
|
|
Click here to expand...
{ name: string templateId: string version: string workflowId: string questionnaireGroupId: string quickRequest: boolean unavailableRequiredServicesCount: integer subCatalogId: string bundle: boolean }
|
|
Click here to expand...
{ dependencyId: string dependedEntityId: string dependedEntityName: string dependencyType: string Enum: [ "SERVICE_VERSION" ] mappings: [ #ServiceDependencyMappingDto ] }
|
|
Click here to expand...
{ sourcePropertyName: string targetPropertyName: string }
|
|
Click here to expand...
{ type: string Enum: [ "IMAGE", "VIDEO" ] url: string }
|
|
Click here to expand...
{ id: string position: integer full: string preview: string videoDescription: string videoId: string locale: 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 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 ] }
|
|
Click here to expand...
{ id: string questionnaireGroupId: 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 date: date-time serviceId: string userId: string rating: double }
|
|
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 }
|
|
Click here to expand...
{ reimportCount: integer }
|
|
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 }
|
|
Click here to expand...
{ userIds: [ string ] userFullNames: [ string ] }
|
|
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 ] }
|
|
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 ] }
|
|
Click here to expand...
{ requestId: string externalId: string questionnaire: string onStartChanges: { } serviceId: string }
|
|
Click here to expand...
{ serviceRequestId: 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 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 }
|
|
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 ] }
|
|
Click here to expand...
{ externalActivityIds: [ string ] }
|
|
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 }
|
| |
| |
|
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 }
|
|
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 }
|
|
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 }
|
|
Click here to expand...
{ categoryIds: [ string ] serviceIds: [ string ] workflowId: string workflowName: string serviceTypeId: string questionnaireId: string questionnaireName: string questionnaireGroupId: string importMapping: [ #ImportServiceTypeDataMapping ] }
|
| |
|
Click here to expand...
{ id: string name: string modifiedDate: date-time serviceCount: integer deactivated: boolean templateType: string Enum: [ "SERVICE", "BUNDLE", "CONNECTOR", "DAY_2_ACTION" ] }
|
|
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 }
|
|
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 }
|
|
Click here to expand...
{ categoryIds: [ 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 Service version name in other language Example: name in French serviceVersionId: string Service version id Example: 12345 locale: string locale Example: en }
|
|
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 ] }
|
| |
|
Click here to expand...
{ day2ActionsAttachedTo: integer The number of services that the Day 2 action is attached to Example: 1 }
|
|
Click here to expand...
{ name: string country: string stateProvince: string city: string zipPostalCode: string street: 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 serviceRevisionId: string description: string files: [ #SlaFile ] links: [ #SlaLink ] metrics: [ #Metric ] }
|
|
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 }
|
| |
|
Click here to expand...
{ methodName: string fileName: string lineNumber: integer className: string nativeMethod: boolean }
|
| |
|
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 }
|
|
Click here to expand...
{ id: string name: string serviceCount: integer day2actionCount: integer adminCount: integer supplierCount: integer }
|
|
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 }
|
|
Click here to expand...
{ id: string name: string companyId: string modifiedDate: date-time servicesCount: integer }
|
| |
|
Click here to expand...
{ previousCount: integer currentCount: integer supplierId: string supplierName: string supplierLogo: string serviceTypeId: string serviceTypeName: 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 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" ] }
|
|
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 }
|
|
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 }
|
|
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 }
|
|
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 }
|
| |
|
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 }
|
|
Click here to expand...
{ timezoneId: string timezoneName: string offset: string }
|
|
Click here to expand...
{ totalSize: integer data: [ { } ] empty: boolean }
|
|
Click here to expand...
{ updateMode: string Enum: [ "READ", "DISMISS" ] notificationIds: [ string ] }
|
|
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 ] }
|
|
Click here to expand...
{ id: string fullName: string password: string groups: [ string ] }
|
|
Click here to expand...
{ loginName: string groupName: string }
|
|
Click here to expand...
{ overlayGroupId: string overlayGroupName: string tenantId: string tenantName: string userOverlayGroupDescriptorChildren: [ #UserOverlayGroupDescriptor ] isWritable: boolean }
|
| |
| |
|
Click here to expand...
{ users: [ #Person ] pageSize: integer page: integer total: integer }
|
|
Click here to expand...
{ criteriaId: string criteriaName: string operator: string Enum: [ "EQUAL", "LIKE", "IN" ] valueId: string valueName: string path: 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 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 }
|
|
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 }
|
|
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 }
|
| |
|
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 }
|