Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

In this article you will learn how to retrieve, create, and update group information using the REST API.

To learn about Groups in ISM, see Create and Manage Groups

GET- Group

To retrieve existing group information, specify the following information in Swagger:

  1. Click GET or Expand Operations to retrieve information.
  2. Specify the following details in the Parameters section.:
      - ISM application URL
      - User authtoken
      - Slice token
      - Web service user name and password
  3. Click Try it out.

POST- Group

To create a new group, specify the following information:

  1. Click POST to create information.
  2. Specify the following details in the Parameters section.:
      - ISM application URL
      - User authtoken
      - Slice token
      - Web service user name and password
  3. Click the Example Value text box. The operations displayed in the text box will be copied to the Group text box.
  4. Click Try it out. 
    The following information is displayed in the Example Value box.
{
"canViewOrgTickets": "string",
"createdBy": "string",
"createdDate": "string",
"elementId": "string",
"excludeFromSurveys": "string",
"groupDescription": "string",
"groupEmail": "string",
"groupMask": "string",
"groupName": "string",
"groupPhone": "string",
"groupRefresh": "string",
"groupSubType": "string",
"groupType": "string",
"modifiedBy": "string",
"modifiedDate": "string",
"nextEscalationGrou": "string",
"nextEscalationGroup": "string",
"relState": "string",
"slice": "string",
"type": "string",
"usedFor": "string"
}

...

PUT method is used when you want to edit an existing record. For example, you have created a group and forgot to specify the next escalation group. To update the information in Group, you can use this method. Specify the following information:

  1. Click PUT to edit the group information.
  2. Specify the following details in the Parameters section.:
      - ISM application URL
      - User authtoken
      - Slice token
      - Web service user name and password
  3. Click the Example Value text box. The operations displayed in the text box will be copied to the Group text box.
  4. Click Try it out. 
    The following information is displayed in the Example Value box.

Code Block- Group Value

{
"canViewOrgTickets": "string",
"createdBy": "string",
"createdDate": "string",
"elementId": "string",
"excludeFromSurveys": "string",
"groupDescription": "string",
"groupEmail": "string",
"groupMask": "string",
"groupName": "string",
"groupPhone": "string",
"groupRefresh": "string",
"groupSubType": "string",
"groupType": "string",
"modifiedBy": "string",
"modifiedDate": "string",
"nextEscalationGrou": "string",
"nextEscalationGroup": "string",
"relState": "string",
"slice": "string",
"type": "string",
"usedFor": "string"
}

...