Create Tickets
Create a ticket of given type.
Notes
- To create an incident.
/api/v2/tenants/{clientId}/incidents
- To create service request.
/api/v2/tenants/{clientId}/serviceRequests
- To create a problem record.
/api/v2/tenants/{clientId}/problems
- To create time bound request.
/api/v2/tenants/{clientId}/timeBoundRequests
- To create change request.
/api/v2/tenants/{clientId}/changeRequests
- To create a task.
/api/v2/tenants/{clientId}/tasks
Path Parameters
- clientId
Describes the clientId of the tenant
- ticketEntity
Supported service desk entity.These are case sensitive.
- Enum:
- incidentsproblemsserviceRequeststimeBoundRequestschangeRequeststasks
Request Body
application/json
- id
- subject
Ticket subject.
- description
Ticket description.
- alertIds
The list of alert ids attached to the incident.
- allowedStatus
- assignedUser
- assigneeGroup
- attachedArticles
- attachedRequests
Attach service requests to an incident. Use the search service requests to get list of service requests in a client.
- attachments
Attach files related to the change request. Convert attachment files to byte stream with base64-encoding. The file size limit of an attachment is 50 MB.
- businessImpact
Incident ticket type attributes
- category
Add the change request under a category. Use the get API to get the list of categories.
- cc
Cc email.
- changePlan
Description of the change plan.
- changeType
Normal or Emergency depending on the Priority of a change request. For example, create a change type Emergency for change requests that must be processed immediately or if Priority of a request is High.
- changeRequest
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
- channelId
- client
- closedsummary
- createdDate
- createdUser
- customFields
- dueDate
Due date for incident type tickets.
- extTicketId
Attach third party ticket ID.
- knowledgeArticleIds
Attach knowledge base articles related to the change request for further reference. To get a knowledge base article ID: 1. Log into OpsRamp. 2. Click Knowledge Base. 3. Select the required article and then copy the article ID. 4. Provide the article ID in "knowledgeArticleIds" field. Example: "knowledgeArticleIds": 25, 16.
- location
- notes
- oldPriority
- oldStatus
- parentId
Attach incident. Provide the incident ID as an attachment.
- participantUsers
- plannedEnd
- plannedStart
- policy
- priority
Ticket priority with supported priority values: Low, Normal, High, Urgent, and Very Low.
- priorityUpdatedBy
- priorityUpdatedDate
- problem
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
- reOpenCount
- requester
- resolutionsummary
- resolveDate
- resources
- rollbackPlan
Description of roll back plan.
- schedule
Time bound tickets schedule.
- serviceRestoreDate
- slaDetails
- source
- sourceEntityType
- sourceEntityTypeId
- sourcePolicyType
- sourcePolicyTypeId
- status
- statusFlow
- statusUpdatedBy
- statusUpdatedDate
- subCategory
Add the change request under a sub-category. Use get categories to get the list of sub-categories.
- tags
- testPlan
Description of test plan.
- ticketArisedTime
- toEmail
Email address of the user. An email notification is sent to the user.
- updatedDate
- urgency
- workEnd
- workStart
- notifyRoster
Roster defined for incident ticket type only
Responses
- id
- subject
Ticket subject.
- description
Ticket description.
- alertIds
The list of alert ids attached to the incident.
- allowedStatus
- assignedUser
- assigneeGroup
- attachedArticles
- attachedRequests
Attach service requests to an incident. Use the search service requests to get list of service requests in a client.
- attachments
Attach files related to the change request. Convert attachment files to byte stream with base64-encoding. The file size limit of an attachment is 50 MB.
- businessImpact
Incident ticket type attributes
- category
Add the change request under a category. Use the get API to get the list of categories.
- cc
Cc email.
- changePlan
Description of the change plan.
- changeType
Normal or Emergency depending on the Priority of a change request. For example, create a change type Emergency for change requests that must be processed immediately or if Priority of a request is High.
- changeRequest
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
- channelId
- client
- closedsummary
- createdDate
- createdUser
- customFields
- dueDate
Due date for incident type tickets.
- extTicketId
Attach third party ticket ID.
- knowledgeArticleIds
Attach knowledge base articles related to the change request for further reference. To get a knowledge base article ID: 1. Log into OpsRamp. 2. Click Knowledge Base. 3. Select the required article and then copy the article ID. 4. Provide the article ID in "knowledgeArticleIds" field. Example: "knowledgeArticleIds": 25, 16.
- location
- notes
- oldPriority
- oldStatus
- parentId
Attach incident. Provide the incident ID as an attachment.
- participantUsers
- plannedEnd
- plannedStart
- policy
- priority
Ticket priority with supported priority values: Low, Normal, High, Urgent, and Very Low.
- priorityUpdatedBy
- priorityUpdatedDate
- problem
Attach a problem or change request related to the incident. Only a single change request or problem can be attached to an incident.
- reOpenCount
- requester
- resolutionsummary
- resolveDate
- resources
- rollbackPlan
Description of roll back plan.
- schedule
Time bound tickets schedule.
- serviceRestoreDate
- slaDetails
- source
- sourceEntityType
- sourceEntityTypeId
- sourcePolicyType
- sourcePolicyTypeId
- status
- statusFlow
- statusUpdatedBy
- statusUpdatedDate
- subCategory
Add the change request under a sub-category. Use get categories to get the list of sub-categories.
- tags
- testPlan
Description of test plan.
- ticketArisedTime
- toEmail
Email address of the user. An email notification is sent to the user.
- updatedDate
- urgency
- workEnd
- workStart
- notifyRoster
Roster defined for incident ticket type only