IcM (Preview)
This connector is intended to be used to ease IcM automation processes using Power Platform.
This connector is available in the following products and regions:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
| Power Apps | Standard | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Power Automate | Standard | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
| Contact | |
|---|---|
| Name | Power Apps RP Team |
| URL | Microsoft LogicApps Support Microsoft Power Automate Support Microsoft Power Apps Support |
| powerapps-rp-lc@microsoft.com |
| Connector Metadata | |
|---|---|
| Publisher | Microsoft |
| Website | https://make.powerapps.com |
| Privacy policy | https://www.microsoft.com/privacy/privacystatement |
| Categories | Productivity |
Throttling Limits
| Name | Calls | Renewal Period |
|---|---|---|
| API calls per connection | 30 | 60 seconds |
Actions
| Add new IcM Discussion entry |
Add new IcM Discussion entry |
| Create IcM incident |
Create IcM incident (https://aka.ms/icm-connector-create-incident) |
| Get bridges for an incident |
Get bridges for an incident |
| Get current oncall contact list |
Get current oncall contact list |
| Get description entries for an incident |
Get description entries for an incident |
| Get incident |
Get incident |
| Get retrospective by Id |
Get retrospective by Id |
| Get retrospective by incident Id |
Get retrospective by incident Id |
| Mitigate incident |
Mitigate an incident. |
| Reactivate incident |
Reactivate (activate) an incident from mitigated or resolved state. |
| Resolve incident |
Resolve an incident. |
| Search IcM teams |
Search IcM teams (note: the "Public team Id" and "Team name" are treated as logical OR when both are specified). |
| Search incidents |
Search incidents |
| Send an HTTP request |
Construct an ICM REST API request to invoke. The request is restricted to prod.microsofticm.com and euprod.microsofticm.com hosts only. |
| Tag user in discussion |
Tags a user in the incident discussion by adding a discussion entry and sending an email notification. This is a convenience operation that combines adding a discussion entry and sending an email notification. |
| Transfer incident |
Transfer an incident to another team. |
| Update incident custom fields |
Update custom fields for an incident (team, service, or service category level) |
| Update incident owner |
Update incident owner (owning contact alias) |
| Update incident severity |
Update incident severity |
| Update incident title |
Update incident title |
Add new IcM Discussion entry
Add new IcM Discussion entry
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
discussionText
|
discussionText | string |
Discussion entry. |
|
|
renderType
|
renderType | string |
Render type. |
Create IcM incident
Create IcM incident (https://aka.ms/icm-connector-create-incident)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
owningTeam
|
owningTeam | string |
Owning team. |
|
|
connectorId
|
connectorId | True | string |
Connector Id (https://aka.ms/icm-connector-create-incident). |
|
correlationId
|
correlationId | string |
Correlation Id. |
|
|
routingId
|
routingId | string |
Routing Id. |
|
|
title
|
title | True | string |
Title. |
|
howFound
|
howFound | string |
How found. |
|
|
severity
|
severity | string |
Severity. |
|
|
discussionText
|
discussionText | string |
Discussion entry. |
|
|
renderType
|
renderType | string |
Render type. |
|
|
summary
|
summary | string |
Summary. |
|
|
tags
|
tags | string |
Semicolon separated list of tags for incident. |
|
|
cloudInstance
|
cloudInstance | string |
Cloud instance. |
|
|
environment
|
environment | string |
Environment where the incident occurred. |
|
|
dcRegion
|
dcRegion | string |
Datacenter or region where the incident occurred. |
|
|
instanceCluster
|
instanceCluster | string |
Instance, cluster, or device name where the incident occurred. |
|
|
role
|
role | string |
Role or the device group where the incident occured. |
|
|
slice
|
slice | string |
Slice or the service instance id where the incident occured. |
Returns
Get bridges for an incident
Get bridges for an incident
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
Returns
Incident bridges response model.
- Body
- IcmBridgesResponse
Get current oncall contact list
Get current oncall contact list
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Team Id
|
teamId | string |
Team Id. |
Returns
ICM current on-call response model.
Get description entries for an incident
Get description entries for an incident
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Count
|
count | integer |
Number of entries to return. |
|
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Returns
Incident description entries response model.
Get incident
Get incident
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
Returns
Incident response model.
- Body
- IcmIncidentResponse
Get retrospective by Id
Get retrospective by Id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Retrospective Id
|
retrospectiveId | True | string |
Retrospective Id. |
Returns
Incident retrospective response model.
Get retrospective by incident Id
Get retrospective by incident Id
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
Returns
Incident retrospective response model.
Mitigate incident
Mitigate an incident.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Is Customer Impacting
|
isCustomerImpacting | boolean |
Whether the incident is customer impacting. |
|
|
Is Noise
|
isNoise | boolean |
Whether the incident is noise. |
|
|
Mitigation
|
mitigation | True | string |
The mitigation description. |
|
How Fixed
|
howFixed | string |
How the incident was fixed. |
|
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Reactivate incident
Reactivate (activate) an incident from mitigated or resolved state.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Disable Voice Notifications
|
disableVoiceNotifications | boolean |
Whether to disable voice notifications. |
|
|
Description
|
description | True | string |
Description for reactivating the incident. |
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Resolve incident
Resolve an incident.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Is Customer Impacting
|
isCustomerImpacting | boolean |
Whether the incident is customer impacting. |
|
|
Is Noise
|
isNoise | boolean |
Whether the incident is noise. |
|
|
Description
|
description | True | string |
Description for the resolution. |
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Search IcM teams
Search IcM teams (note: the "Public team Id" and "Team name" are treated as logical OR when both are specified).
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Public team Id
|
publicId | string |
Public team Id (get it from https://portal.microsofticm.com/imp/v3/administration/teamdashboard/details). |
|
|
Team name
|
name | string |
Team name (e.g. PowerApps Services RP Team). |
|
|
Include team members?
|
includeMembers | boolean |
Whether to include the team members. |
|
|
The number of items to skip
|
$skip | integer |
The number of items to skip. |
Returns
ICM team search response model.
Search incidents
Search incidents
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter (https://aka.ms/icm-search-filter)
|
$filter | True | string |
Filter (https://aka.ms/icm-search-filter). |
|
Select expression
|
$select | string |
Select expression. |
|
|
The number of items to return
|
$top | integer |
The number of items to return. |
|
|
The number of items to skip
|
$skip | integer |
The number of items to skip. |
|
|
Search endpoint
|
searchEndpoint | string |
Search endpoint. |
Returns
ICM incident search response model.
Send an HTTP request
Construct an ICM REST API request to invoke. The request is restricted to prod.microsofticm.com and euprod.microsofticm.com hosts only.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
URI
|
Uri | True | string |
The relative or full URI. Example: /api/user/incidents or https://euprod.microsofticm.com/api/user/incidents |
|
Method
|
Method | True | string |
The HTTP method (default is GET). |
|
|
object | |||
|
Content-Type
|
ContentType | string |
The content-type header for the body (default is application/json). |
Returns
- response
- ObjectWithoutType
Tag user in discussion
Tags a user in the incident discussion by adding a discussion entry and sending an email notification. This is a convenience operation that combines adding a discussion entry and sending an email notification.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Recipient Email
|
recipient | True | string |
Email address of the user to tag (must be a valid @microsoft.com email address). |
|
Discussion Text
|
text | True | string |
The discussion text to add to the incident (supports HTML formatting). |
|
Recipient Display Name
|
recipientDisplayName | string |
Optional. The display name of the recipient for the mention. If not specified, the alias from the email is used. |
|
|
Mentioner Display Name
|
mentionerDisplayName | string |
Optional. The display name of the person mentioning the recipient. If not specified, extracted from the authentication token. Falls back to 'Power Automate' if unavailable. |
|
|
Mentioner Alias
|
mentionerAlias | string |
Optional. The email/alias of the person mentioning the recipient (used for Reply-To header). If not specified, extracted from the authentication token. |
|
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Returns
Response model for tag user in discussion operation.
Transfer incident
Transfer an incident to another team.
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Owning Tenant Public Id
|
owningTenantPublicId | True | string |
The public ID (GUID) of the tenant to transfer the incident to (see https://aka.ms/icm-tenantId). |
|
Owning Team Public Id
|
owningTeamPublicId | True | string |
The public ID of the team to transfer the incident to (see https://aka.ms/icm-teamId). |
|
Description
|
description | True | string |
Optional description for the transfer. |
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Update incident custom fields
Update custom fields for an incident (team, service, or service category level)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Group Type
|
groupType | True | string |
Custom field group type (Team, FrontEndCategory, etc.). |
|
Public ID
|
publicId | string |
Public ID of the team/service/service category. For team-level fields, use '00000000-0000-0000-0000-000000000000'. For service-level fields, use the service GUID. |
|
|
Container ID
|
containerId | string |
Container ID (required for team-level fields, use the team ID). |
|
|
Field Name
|
name | True | string |
Custom field name. |
|
Display Name
|
displayName | string |
Custom field display name. |
|
|
Field Value
|
value | True | string |
Custom field value. |
|
Field Type
|
type | True | string |
Custom field type (Boolean, Enum, ShortString, BigString, DateTime, etc.). |
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Update incident owner
Update incident owner (owning contact alias)
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Owning Contact Alias
|
owningContactAlias | True | string |
Alias of the new owner. |
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Update incident severity
Update incident severity
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Severity
|
severity | True | string |
Severity level (2, 3, 4, or 25). |
|
Description Entry
|
descriptionEntry | string |
Optional description entry to add. |
|
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Update incident title
Update incident title
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Incident Id
|
id | True | string |
Incident Id. |
|
Title
|
title | True | string |
New title for the incident. |
|
ICM endpoint
|
icmEndpoint | string |
ICM endpoint. |
Triggers
| When an IcM incident is created |
When an IcM incident is created |
When an IcM incident is created
When an IcM incident is created
Parameters
| Name | Key | Required | Type | Description |
|---|---|---|---|---|
|
Filter (https://aka.ms/icm-search-filter)
|
$filter | True | string |
Filter (https://aka.ms/icm-search-filter). |
|
Select expression
|
$select | string |
Select expression. |
|
|
Search endpoint
|
searchEndpoint | string |
Search endpoint. |
Returns
Represents a wrapper object for batch trigger response
Definitions
ObjectWithoutType
TagUserInDiscussionResponse
Response model for tag user in discussion operation.
| Name | Path | Type | Description |
|---|---|---|---|
|
success
|
success | boolean |
Indicates if the operation was successful. |
|
incidentId
|
incidentId | string |
The incident ID. |
|
discussionAdded
|
discussionAdded | boolean |
Indicates if the discussion entry was added. |
|
emailSent
|
emailSent | boolean |
Indicates if the email notification was sent. |
|
message
|
message | string |
Status message. |
IcmBridge
Model representing a bridge for an incident.
| Name | Path | Type | Description |
|---|---|---|---|
|
bridgeURI
|
bridgeURI | string |
Bridge URI |
|
bridgeNumber
|
bridgeNumber | string |
Bridge number |
|
bridgeConfId
|
bridgeConfId | string |
Bridge conference Id |
|
expirationDate
|
expirationDate | date-time |
Bridge expiration date |
|
phoneNumber
|
phoneNumber | string |
Bridge phone number |
|
bridgeName
|
bridgeName | string |
Bridge name |
|
bridgeType
|
bridgeType | string |
Bridge type |
IcmBridgesResponse
Incident bridges response model.
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of IcmBridge |
List of bridges |
IcmDescriptionEntriesResponse
Incident description entries response model.
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of object |
List of description entries |
|
items
|
value | object |
IcmContact
ICM contact model.
| Name | Path | Type | Description |
|---|---|---|---|
|
contactId
|
contactId | integer |
Unique identifier of the contact |
|
contactAlias
|
contactAlias | string |
Alias of the contact |
|
contactFullName
|
contactFullName | string |
Full name of the contact |
IcmCurrentOnCallResponse
ICM current on-call response model.
| Name | Path | Type | Description |
|---|---|---|---|
|
teamName
|
teamName | string |
Team name |
|
currentOnCalls
|
currentOnCalls | array of IcmOnCallContact |
Current on-calls |
IcmIncidentAcknowledgementData
Data related to incident acknowledgement.
| Name | Path | Type | Description |
|---|---|---|---|
|
isAcknowledged
|
isAcknowledged | boolean |
Indicates if acknowledged |
|
acknowledgeDate
|
acknowledgeDate | date-time |
Acknowledge date |
|
acknowledgeContactAlias
|
acknowledgeContactAlias | string |
Acknowledge contact alias |
|
notificationId
|
notificationId | string |
Notification ID |
|
notificationToken
|
notificationToken | string |
Notification token |
|
acknowledgeSource
|
acknowledgeSource | string |
Acknowledge source |
IcmIncidentCustomField
Custom field in an incident.
| Name | Path | Type | Description |
|---|---|---|---|
|
name
|
name | string |
Field name |
|
displayName
|
displayName | string |
Display name |
|
value
|
value | string |
Field value |
|
type
|
type | string |
Field type |
IcmIncidentCustomFieldGroup
Group of custom fields for an incident.
| Name | Path | Type | Description |
|---|---|---|---|
|
publicId
|
publicId | string |
Public ID |
|
containerId
|
containerId | string |
Container ID |
|
groupType
|
groupType | string |
Group type |
|
customFields
|
customFields | array of IcmIncidentCustomField |
List of custom fields |
IcmIncidentDescriptionEntry
Entry in the incident description.
| Name | Path | Type | Description |
|---|---|---|---|
|
descriptionEntryId
|
descriptionEntryId | string |
Description entry ID |
|
incidentId
|
incidentId | string |
Incident ID |
|
text
|
text | string |
Entry text |
|
cause
|
cause | string |
Cause of the entry |
|
changedBy
|
changedBy | string |
Changed by |
|
date
|
date | date-time |
Change date |
|
submittedBy
|
submittedBy | string |
Submitted by |
|
submitDate
|
submitDate | date-time |
Submission date |
|
isFromConnector
|
isFromConnector | boolean |
Indicates if the entry is from a connector |
|
historyId
|
historyId | string |
History ID |
|
isHtml
|
isHtml | boolean |
Indicates if the entry is HTML |
|
renderType
|
renderType | string |
Render type |
|
initials
|
initials | string |
Initials |
|
submittedByDisplayName
|
submittedByDisplayName | string |
Submitted by display name |
|
changedByDisplayName
|
changedByDisplayName | string |
Changed by display name |
|
category
|
category | string |
Entry category |
IcmIncidentLocation
Location information related to an incident.
| Name | Path | Type | Description |
|---|---|---|---|
|
environment
|
environment | string |
Environment |
|
dataCenter
|
dataCenter | string |
Data center |
|
deviceGroup
|
deviceGroup | string |
Device group |
|
deviceName
|
deviceName | string |
Device name |
|
serviceInstanceId
|
serviceInstanceId | string |
Service instance ID |
IcmIncidentMitigationData
Mitigation data related to an incident.
| Name | Path | Type | Description |
|---|---|---|---|
|
date
|
date | date-time |
Mitigation date |
|
changedBy
|
changedBy | string |
Mitigation changed by |
|
mitigation
|
mitigation | string |
Mitigation description |
IcmIncidentResolutionData
Resolution data related to an incident.
| Name | Path | Type | Description |
|---|---|---|---|
|
date
|
date | date-time |
Resolution date |
|
changedBy
|
changedBy | string |
Resolution changed by |
|
createPostmortem
|
createPostmortem | boolean |
Whether to create a postmortem for the incident |
IcmIncidentResponse
Incident response model.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
Incident ID |
|
severity
|
severity | integer |
Incident severity |
|
status
|
status | string |
Incident status |
|
createDate
|
createDate | date-time |
Creation date |
|
modifiedDate
|
modifiedDate | date-time |
Last modified date |
|
source
|
source | IcmIncidentSource |
Source of an incident. |
|
correlationId
|
correlationId | string |
Correlation ID |
|
routingId
|
routingId | string |
Routing ID |
|
raisingLocation
|
raisingLocation | IcmIncidentLocation |
Location information related to an incident. |
|
incidentLocation
|
incidentLocation | IcmIncidentLocation |
Location information related to an incident. |
|
parentIncidentId
|
parentIncidentId | string |
Parent incident ID |
|
relatedLinksCount
|
relatedLinksCount | integer |
Count of related links |
|
externalLinksCount
|
externalLinksCount | integer |
Count of external links |
|
lastCorrelationDate
|
lastCorrelationDate | date-time |
Last correlation date |
|
hitCount
|
hitCount | integer |
Hit count |
|
childCount
|
childCount | integer |
Child count |
|
title
|
title | string |
Incident title |
|
reproSteps
|
reproSteps | string |
Reproduction steps |
|
owningContactAlias
|
owningContactAlias | string |
Owning contact alias |
|
owningTenantId
|
owningTenantId | string |
Owning tenant ID |
|
owningTeamId
|
owningTeamId | string |
Owning team ID |
|
mitigationData
|
mitigationData | IcmIncidentMitigationData |
Mitigation data related to an incident. |
|
resolutionData
|
resolutionData | IcmIncidentResolutionData |
Resolution data related to an incident. |
|
isCustomerImpacting
|
isCustomerImpacting | boolean |
Indicates if the incident is customer impacting |
|
isNoise
|
isNoise | boolean |
Indicates if the incident is noise |
|
isSecurityRisk
|
isSecurityRisk | boolean |
Indicates if the incident is a security risk |
|
tsgId
|
tsgId | string |
TSG ID |
|
customerName
|
customerName | string |
Customer name |
|
commitDate
|
commitDate | date-time |
Commit date |
|
keywords
|
keywords | string |
Keywords |
|
component
|
component | string |
Component |
|
incidentType
|
incidentType | string |
Incident type |
|
impactStartDate
|
impactStartDate | date-time |
Impact start date |
|
originatingTenantId
|
originatingTenantId | string |
Originating tenant ID |
|
subscriptionId
|
subscriptionId | string |
Subscription ID |
|
supportTicketId
|
supportTicketId | string |
Support ticket ID |
|
monitorId
|
monitorId | string |
Monitor ID |
|
incidentSubType
|
incidentSubType | string |
Incident subtype |
|
howFixed
|
howFixed | string |
How the incident was fixed |
|
tsgOutput
|
tsgOutput | string |
TSG output |
|
sourceOrigin
|
sourceOrigin | string |
Source origin |
|
responsibleTenantId
|
responsibleTenantId | string |
Responsible tenant ID |
|
responsibleTeamId
|
responsibleTeamId | string |
Responsible team ID |
|
impactedServicesIds
|
impactedServicesIds | array of string |
List of impacted services IDs |
|
impactedTeamsPublicIds
|
impactedTeamsPublicIds | array of string |
List of impacted teams public IDs |
|
impactedComponents
|
impactedComponents | array of string |
List of impacted components |
|
newDescriptionEntry
|
newDescriptionEntry | string |
New description entry |
|
acknowledgementData
|
acknowledgementData | IcmIncidentAcknowledgementData |
Data related to incident acknowledgement. |
|
reactivationData
|
reactivationData |
Reactivation data |
|
|
customFieldGroups
|
customFieldGroups | array of IcmIncidentCustomFieldGroup |
List of custom field groups |
|
externalIncidents
|
externalIncidents | array of |
List of external incidents |
|
siloId
|
siloId | string |
Silo ID |
|
incidentManagerContactId
|
incidentManagerContactId | string |
Incident manager contact ID |
|
executiveIncidentManagerContactId
|
executiveIncidentManagerContactId | string |
Executive incident manager contact ID |
|
communicationsManagerContactId
|
communicationsManagerContactId | string |
Communications manager contact ID |
|
siteReliabilityContactId
|
siteReliabilityContactId | string |
Site reliability contact ID |
|
healthResourceId
|
healthResourceId | string |
Health resource ID |
|
diagnosticsLink
|
diagnosticsLink | string |
Diagnostics link |
|
changeList
|
changeList |
Change list |
|
|
isOutage
|
isOutage | boolean |
Indicates if the incident is an outage |
|
outageImpactLevel
|
outageImpactLevel | string |
Outage impact level |
|
summary
|
summary | string |
Incident summary |
|
tags
|
tags | array of string |
List of tags |
|
isCustomerSupportEngagement
|
isCustomerSupportEngagement | boolean |
Indicates if there is customer support engagement |
|
descriptionEntries
|
descriptionEntries | array of IcmIncidentDescriptionEntry |
Description entries |
|
retrospectiveId
|
retrospectiveId | string |
Retrospective ID |
|
bridges
|
bridges | array of IcmBridge |
List of bridges |
IcmIncidentResponseTriggerBatchResponse
Represents a wrapper object for batch trigger response
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of IcmIncidentResponse |
A list of the response objects |
IcmIncidentSearchResponse
ICM incident search response model.
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of IcmIncidentResponse |
Collection of found ICM incidents. |
|
odata.nextLink
|
odata.nextLink | string |
Link to the next page of results, if any. |
|
@odata.nextLink
|
@odata.nextLink | string |
Link to the next page of results, if any. |
IcmIncidentSource
Source of an incident.
| Name | Path | Type | Description |
|---|---|---|---|
|
sourceId
|
sourceId | string |
Source ID |
|
origin
|
origin | string |
Origin |
|
createdBy
|
createdBy | string |
Created by |
|
createDate
|
createDate | date-time |
Creation date |
|
incidentId
|
incidentId | string |
Incident ID |
|
modifiedDate
|
modifiedDate | date-time |
Last modified date |
|
revision
|
revision | string |
Revision |
IcmOnCallContact
ICM OnCall contact model.
| Name | Path | Type | Description |
|---|---|---|---|
|
contactId
|
contactId | integer |
Unique identifier of the contact |
|
alias
|
alias | string |
Alias of the contact |
|
firstName
|
firstName | string |
First name of the contact |
|
lastName
|
lastName | string |
Last name of the contact |
|
status
|
status | string |
Status of the contact |
|
emailAddress
|
emailAddress | string |
Email address of the contact |
IcmOwningTeam
ICM owning team model.
| Name | Path | Type | Description |
|---|---|---|---|
|
entityId
|
entityId | integer |
Unique identifier of the entity |
|
entityName
|
entityName | string |
Name of the entity |
IcmRetrospectiveCustomField
Represents a custom field in an incident retrospective.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
Unique identifier of the custom field entry |
|
customFieldId
|
customFieldId | integer |
Identifier of the custom field definition |
|
stringValue
|
stringValue | string |
String value of the custom field |
|
numberValue
|
numberValue | double |
Numeric value of the custom field |
|
booleanValue
|
booleanValue | boolean |
Boolean value of the custom field |
|
enumValueId
|
enumValueId | integer |
Identifier of the enum value |
|
enumValue
|
enumValue | string |
Enum value as string |
|
dateTimeOffsetValue
|
dateTimeOffsetValue | date-time |
DateTimeOffset value of the custom field |
|
modifiedTime
|
modifiedTime | date-time |
Last modified time of the custom field |
|
additionalData
|
additionalData | string |
Additional data for the custom field |
|
customFieldDataType
|
customFieldDataType | string |
Data type of the custom field |
IcmRetrospectiveDetection
Model representing a detection in an incident retrospective.
| Name | Path | Type | Description |
|---|---|---|---|
|
source
|
source | string |
Source of the detection |
|
details
|
details | string |
Details about the detection |
IcmRetrospectiveFileAttachment
Represents a file attachment in an incident retrospective.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
Unique identifier of the file attachment |
|
fileName
|
fileName | string |
Name of the uploaded file |
|
fileUrl
|
fileUrl | string |
URL where the file is accessible |
|
contentBase64
|
contentBase64 | string |
Base64 encoded content of the file |
|
incidentId
|
incidentId | integer |
Identifier of the associated incident |
|
uploadedBy
|
uploadedBy | string |
Alias of the user who uploaded the file |
|
uploadedDate
|
uploadedDate | date-time |
Date and time when the file was uploaded |
|
size
|
size | integer |
Size of the file in bytes |
|
type
|
type | string |
Type or format of the file |
|
allowAnonymousAccess
|
allowAnonymousAccess | boolean |
Indicates whether anonymous access is allowed |
IcmRetrospectiveLink
Represents a link in an incident retrospective.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
Unique identifier of the link |
|
description
|
description | string |
Description of the link |
|
link
|
link | string |
Link |
IcmRetrospectiveRepairItem
Represents a repair item in an incident retrospective.
| Name | Path | Type | Description |
|---|---|---|---|
|
adoWorkItemId
|
adoWorkItemId | string |
Work item Id in Azure DevOps (ADO) associated with the repair item |
|
additionalData
|
additionalData | IcmRetrospectiveRepairItemAdditionalData |
Represents an additional data of a repair item in an incident retrospective. |
|
id
|
id | integer |
Unique identifier of the repair item |
|
title
|
title | string |
Title of the repair item |
|
owner
|
owner | string |
Owner of the repair item |
|
status
|
status | string |
Status of the repair item |
|
changedDate
|
changedDate | date-time |
Changed date of the repair item |
IcmRetrospectiveRepairItemAdditionalData
Represents an additional data of a repair item in an incident retrospective.
| Name | Path | Type | Description |
|---|---|---|---|
|
repairItemType
|
repairItemType | string |
Repair item type |
|
repairItemDeliveryType
|
repairItemDeliveryType | string |
Repair item delivery type |
|
workItemType
|
workItemType | string |
Work item type of the repair item |
|
source
|
source | string |
Source of the repair item |
|
revision
|
revision | integer |
Revision of the repair item |
|
areapath
|
areapath | string |
Area path of the repair item |
|
tags
|
tags | string |
Tags of the repair item |
|
vstsCreatedDate
|
vstsCreatedDate | date-time |
Created date of the repair item in ADO |
|
vstsClosedDate
|
vstsClosedDate | date-time |
Closed date of the repair item in ADO |
IcmRetrospectiveResponse
Incident retrospective response model.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | integer |
Unique identifier of the retrospective |
|
communicationManagerId
|
communicationManagerId | integer |
Identifier of the communication manager |
|
createdDate
|
createdDate | date-time |
Date when the retrospective was created |
|
creationIncidentId
|
creationIncidentId | integer |
Incident ID that triggered the creation of the retrospective |
|
customerImpact
|
customerImpact | string |
Description of customer impact |
|
findings
|
findings | string |
Findings from the retrospective analysis |
|
howFixed
|
howFixed | string |
Explanation of how the issue was fixed |
|
detection
|
detection | IcmRetrospectiveDetection |
Model representing a detection in an incident retrospective. |
|
impactDuration
|
impactDuration | string |
Duration of the impact |
|
impactStart
|
impactStart | date-time |
Start time of the impact |
|
impactStartDescription
|
impactStartDescription | string |
Description of the impact start |
|
incidentManagerId
|
incidentManagerId | integer |
Identifier of the incident manager |
|
executiveIncidentManagerId
|
executiveIncidentManagerId | integer |
Identifier of the executive incident manager |
|
incidentRaisedDate
|
incidentRaisedDate | date-time |
Date when the incident was raised |
|
isCausedByChange
|
isCausedByChange | boolean |
Indicates whether the incident was caused by a change |
|
modifiedDate
|
modifiedDate | date-time |
Date when the retrospective was last modified |
|
owningTeamId
|
owningTeamId | integer |
Identifier of the owning team |
|
owningTeam
|
owningTeam | IcmOwningTeam |
ICM owning team model. |
|
owningTenantId
|
owningTenantId | integer |
Identifier of the owning tenant |
|
owningTenant
|
owningTenant | IcmOwningTeam |
ICM owning team model. |
|
owningFrontEndCategoryId
|
owningFrontEndCategoryId | integer |
Identifier of the owning front-end category |
|
owningServiceCategory
|
owningServiceCategory | IcmOwningTeam |
ICM owning team model. |
|
postmortemOwnerId
|
postmortemOwnerId | integer |
Identifier of the retrospective owner |
|
postmortemOwner
|
postmortemOwner | IcmContact |
ICM contact model. |
|
qosImpact
|
qosImpact | string |
Quality of service impact details |
|
receivedImpact
|
receivedImpact | string |
Received impact description |
|
repeatOutage
|
repeatOutage | boolean |
Indicates whether this is a repeat outage |
|
repeatOutageDetail
|
repeatOutageDetail | string |
Details of the repeat outage |
|
rootCauseDetails
|
rootCauseDetails | string |
Details of the root cause |
|
rootCauseCategory
|
rootCauseCategory | string |
Category of the root cause |
|
rootCauseSubCategory
|
rootCauseSubCategory | string |
Subcategory of the root cause |
|
rootCauseMitigation
|
rootCauseMitigation | string |
Mitigation steps for the root cause |
|
rootCauseTitle
|
rootCauseTitle | string |
Title summarizing the root cause |
|
serviceImpacted
|
serviceImpacted | string |
Name of the impacted service |
|
serviceResponsible
|
serviceResponsible | string |
Name of the responsible service |
|
serviceRestoreDate
|
serviceRestoreDate | date-time |
Date when the service was restored |
|
severity
|
severity | integer |
Severity level of the incident |
|
startDate
|
startDate | date-time |
Start date of the incident |
|
status
|
status | string |
Status of the retrospective |
|
summary
|
summary | string |
Summary of the retrospective |
|
timeline
|
timeline | IcmRetrospectiveTimeline |
ICM retrospective timeline model. |
|
title
|
title | string |
Title of the retrospective |
|
isReadonly
|
isReadonly | boolean |
Indicates whether the retrospective is read-only |
|
rootCauseId
|
rootCauseId | integer |
Identifier of the root cause |
|
customFields
|
customFields | array of IcmRetrospectiveCustomField |
List of custom fields |
|
attachments
|
attachments | array of IcmRetrospectiveFileAttachment |
List of attachments |
|
links
|
links | array of IcmRetrospectiveLink |
List of links |
|
repairItems
|
repairItems | array of IcmRetrospectiveRepairItem |
List of repair items |
|
whyItems
|
whyItems | array of IcmRetrospectiveWhyItem |
List of Why items |
IcmRetrospectiveTimeline
ICM retrospective timeline model.
| Name | Path | Type | Description |
|---|---|---|---|
|
commsEngaged
|
commsEngaged | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
dashboard
|
dashboard | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
detailedCustomerAdvisory
|
detailedCustomerAdvisory | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
detection
|
detection | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
diagnosis
|
diagnosis | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
engineerEngaged
|
engineerEngaged | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
firstCustomerAdvisory
|
firstCustomerAdvisory | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
mitigation
|
mitigation | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
other1
|
other1 | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
other2
|
other2 | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
other3
|
other3 | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
recovery
|
recovery | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
triage
|
triage | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
|
outageDeclared
|
outageDeclared | IcmRetrospectiveTimelineEntry |
Represents a single entry in the retrospective timeline of an incident. |
IcmRetrospectiveTimelineEntry
Represents a single entry in the retrospective timeline of an incident.
| Name | Path | Type | Description |
|---|---|---|---|
|
date
|
date | date-time |
Date of the timeline entry |
|
description
|
description | string |
Description of the timeline entry |
IcmRetrospectiveWhyItem
Represents a Why item in an incident retrospective.
| Name | Path | Type | Description |
|---|---|---|---|
|
questionId
|
questionId | string |
Identifier of the Why item |
|
title
|
title | string |
Title of the Why item |
|
content
|
content | string |
Content of the Why item |
IcmTeam
ICM team model.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
Id of the team. |
|
syncId
|
syncId | string |
Synchronization identifier for the team. |
|
rotationTransitionTime
|
rotationTransitionTime | string |
Time of day when rotation transitions occur. |
|
firstRotationPeriodDate
|
firstRotationPeriodDate | date-time |
Date of the first rotation period. |
|
rotationPeriodLength
|
rotationPeriodLength | string |
Length of each rotation period. |
|
timeZoneId
|
timeZoneId | string |
Time zone identifier for the team. |
|
publicId
|
publicId | string |
Public Id of the team. |
|
name
|
name | string |
Name of the team. |
|
description
|
description | string |
Description of the team. |
|
email
|
string |
Email address associated with the team. |
|
|
isTombstoned
|
isTombstoned | boolean |
Indicates whether the team is tombstoned. |
|
isAssignable
|
isAssignable | boolean |
Indicates whether the team is assignable. |
|
isVirtual
|
isVirtual | boolean |
Indicates whether the team is virtual. |
|
rotationMemberCount
|
rotationMemberCount | integer |
Number of rotation members in the team. |
|
highSeverityThreshold
|
highSeverityThreshold | integer |
Severity threshold for high severity incidents. |
|
arePhoneCallHoursRestricted
|
arePhoneCallHoursRestricted | boolean |
Indicates whether phone call hours are restricted. |
|
tenant
|
tenant | IcmTenant |
Represents a n IcM tenant model. |
|
members
|
members | array of IcmTeamMember |
List of members in the team. |
IcmTeamMember
Represents a member of an ICM team.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
Id of the member |
|
alias
|
alias | string |
Alias of the member |
|
firstName
|
firstName | string |
First name of the member |
|
lastName
|
lastName | string |
Last name of the member |
|
emailAddress
|
emailAddress | string |
Email address of the member |
|
timeZoneId
|
timeZoneId | string |
Time zone identifier for the member |
|
upn
|
upn | string |
User principal name |
|
isPrivate
|
isPrivate | boolean |
Indicates if the member's contact details are private |
|
status
|
status | string |
Current status of the member |
|
optOutCommunication
|
optOutCommunication | boolean |
Indicates if the member has opted out of communications |
IcmTeamSearchResponse
ICM team search response model.
| Name | Path | Type | Description |
|---|---|---|---|
|
value
|
value | array of IcmTeam |
Collection of found ICM teams. |
|
odata.nextLink
|
odata.nextLink | string |
Link to the next page of results, if any. |
|
@odata.nextLink
|
@odata.nextLink | string |
Link to the next page of results, if any. |
IcmTenant
Represents a n IcM tenant model.
| Name | Path | Type | Description |
|---|---|---|---|
|
id
|
id | string |
Id of the tenant |
|
publicId
|
publicId | string |
Public Id of the tenant |
|
tenantGuid
|
tenantGuid | string |
GUID of the tenant |
|
name
|
name | string |
Name of the tenant |
|
siloId
|
siloId | string |
Silo identifier associated with the tenant |
|
description
|
description | string |
Description or notes about the tenant |
|
highSeverityThreshold
|
highSeverityThreshold | integer |
Threshold for high severity incidents |
|
emailSeverityThreshold
|
emailSeverityThreshold | integer |
Threshold for email notifications based on severity |
|
accessRequestAddress
|
accessRequestAddress | string |
Email address for access requests |
|
accessRequestFriendlyName
|
accessRequestFriendlyName | string |
Friendly name shown for access requests |
|
keywords
|
keywords | string |
Keywords associated with the tenant |
|
frontEndCategoryId
|
frontEndCategoryId | string |
Identifier for the front-end category |
|
frontEndCategoryName
|
frontEndCategoryName | string |
Name of the front-end category |
|
incidentManagerTeamId
|
incidentManagerTeamId | string |
Team ID for incident management |
|
communicationsManagerTeamId
|
communicationsManagerTeamId | string |
Team ID for communications management |
|
securityTeamId
|
securityTeamId | string |
Team ID for security management |
|
incidentManagerTeamName
|
incidentManagerTeamName | string |
Name of the incident manager team |
|
communicationsManagerTeamName
|
communicationsManagerTeamName | string |
Name of the communications manager team |
|
securityTeamName
|
securityTeamName | string |
Name of the security team |
|
status
|
status | string |
Current status of the tenant |
IncidentAddUpdateResult
| Name | Path | Type | Description |
|---|---|---|---|
|
incidentId
|
incidentId | integer | |
|
status
|
status | IncidentAddUpdateStatus | |
|
subStatus
|
subStatus | IncidentAddUpdateSubStatus | |
|
updateProcessTime
|
updateProcessTime | date-time |