Jump to

• Request
• Response

List of annotations for the incident

get

https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/incidents/{incidentId}/annotations

Returns a list of annotations for the incident with the most recent ones listed first by default.

Request

Path Parameters

• incidentId(required): string(raw)
  ID of the incident

Query Parameters

• limit: integer(int32)
  Limits number of items returned in current call. Use the self/previous/next links from the response to fetch additional items.

  Default Value: 50
• page: string
  Identifies the set of items to be fetched; "href" element from "links" list of the response provides encoded value for this parameter. "href" element value should be used "as is" for fetching respective set of items.

  Default Value: Base64 encode value of 0 i.e MA==
• sort: string
  Sort results by supported resource attributes such as id, message, type, timeCreated and createdBy

  Example:

  type:ASC,timeCreated:DESC

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation - Fetch all the related annotations to the incident

Body ()

Root Schema : AnnotationCollection

Type: object

List of annotations

Show Source

• count: integer (int32)
  Number of rows returned

  Example: 1
• items(required): array items
  List of the annotation summary
• links: object links
  Read Only: true

  URL links to paginated resource(s).

{
    "required":[
        "items"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"Number of rows returned",
            "format":"int32",
            "example":1
        },
        "links":{
            "required":[
                "self"
            ],
            "type":"object",
            "properties":{
                "self":{
                    "$ref":"#/components/schemas/Link"
                },
                "next":{
                    "$ref":"#/components/schemas/Link"
                },
                "previous":{
                    "$ref":"#/components/schemas/Link"
                }
            },
            "description":"URL links to paginated resource(s).",
            "readOnly":true,
            "example":{
                "self":{
                    "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MQ%3D%3D&limit=50"
                },
                "next":{
                    "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=Mg%3D%3D&limit=50"
                },
                "previous":{
                    "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MA%3D%3D&limit=50"
                }
            }
        },
        "items":{
            "type":"array",
            "description":"List of the annotation summary",
            "items":{
                "$ref":"#/components/schemas/AnnotationSummary"
            }
        }
    },
    "description":"List of annotations"
}

Nested Schema : items

Type: array

List of the annotation summary

Show Source

• Array of: object AnnotationSummary
  Details of an annotation

{
    "type":"array",
    "description":"List of the annotation summary",
    "items":{
        "$ref":"#/components/schemas/AnnotationSummary"
    }
}

Nested Schema : links

Type: object

Read Only: true

URL links to paginated resource(s).

Show Source

• next: object Link
  Represents a link(could be self, previous or next)
• previous: object Link
  Represents a link(could be self, previous or next)
• self(required): object Link
  Represents a link(could be self, previous or next)

{
    "required":[
        "self"
    ],
    "type":"object",
    "properties":{
        "self":{
            "$ref":"#/components/schemas/Link"
        },
        "next":{
            "$ref":"#/components/schemas/Link"
        },
        "previous":{
            "$ref":"#/components/schemas/Link"
        }
    },
    "description":"URL links to paginated resource(s).",
    "readOnly":true,
    "example":{
        "self":{
            "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MQ%3D%3D&limit=50"
        },
        "next":{
            "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=Mg%3D%3D&limit=50"
        },
        "previous":{
            "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MA%3D%3D&limit=50"
        }
    }
}

Example:

{
    "self":{
        "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MQ%3D%3D&limit=50"
    },
    "next":{
        "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=Mg%3D%3D&limit=50"
    },
    "previous":{
        "href":"/em/api/incidents/C4E214A1172A2F19E053860E4B645AC7/annotations?page=MA%3D%3D&limit=50"
    }
}

Nested Schema : AnnotationSummary

Type: object

Details of an annotation

Show Source

• createdBy: string
  Read Only: true

  Creator of the annotation - User or SYSTEM

  Example: SYSMAN
• id: string
  Read Only: true

  Unique identifier of the annotation in context of the current object

  Example: 131
• message(required): string
  Minimum Length: 1

  Maximum Length: 4000

  Text for the annotation

  Example: Suppression removed as the underlying issue resolved
• timeCreated: string (datetime)
  Read Only: true

  Time when the annotation is created

  Example: 2021-07-21T06:25:43.000Z
• type(required): string
  Allowed Values: [ "USER_COMMENT", "NOTIFICATION", "SYSTEM" ]

  Annotation type

  Example: USER_COMMENT

{
    "required":[
        "message",
        "type"
    ],
    "type":"object",
    "properties":{
        "message":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"Text for the annotation",
            "example":"Suppression removed as the underlying issue resolved"
        },
        "id":{
            "type":"string",
            "description":"Unique identifier of the annotation in context of the current object",
            "readOnly":true,
            "example":"131"
        },
        "type":{
            "type":"string",
            "description":"Annotation type",
            "example":"USER_COMMENT",
            "enum":[
                "USER_COMMENT",
                "NOTIFICATION",
                "SYSTEM"
            ]
        },
        "timeCreated":{
            "type":"string",
            "description":"Time when the annotation is created",
            "format":"datetime",
            "readOnly":true,
            "example":"2021-07-21T06:25:43.000Z"
        },
        "createdBy":{
            "type":"string",
            "description":"Creator of the annotation - User or SYSTEM",
            "readOnly":true,
            "example":"SYSMAN"
        }
    },
    "description":"Details of an annotation"
}

Nested Schema : Link

Type: object

Represents a link(could be self, previous or next)

Show Source

• href: string
  URL for Link

  Example: /em/api/<resources>?page=b2Zmc2V0OjA&limit=0

{
    "type":"object",
    "description":"Represents a link(could be self, previous or next)",
    "properties":{
        "href":{
            "type":"string",
            "description":"URL for Link",
            "example":"/em/api/<resources>?page=b2Zmc2V0OjA&limit=0"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

401 Response

Unauthorized

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

404 Response

Not Found

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

503 Response

Service Unavailable

Body ()

Root Schema : ErrorResponse

Type: object

Error response

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing
• message(required): string
  A human-readable error string

{
    "description":"Error response",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "description":"A short error code that defines the error, meant for programmatic parsing",
            "type":"string"
        },
        "message":{
            "description":"A human-readable error string",
            "type":"string"
        }
    }
}

Back to Top