Jump to

• Request
• Response

Get Comments

get

/essbase/rest/v1/scenarios/{scenarioId}/comments

Gets comments for the specified scenario ID.

Request

Path Parameters

• scenarioId: integer(int64)

  Scenario ID.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Scenario comments returned successfully.

Body ()

Root Schema : Comments

Type: object

Show Source

• count(optional): integer(int64)
• hasMore(optional): boolean
• items(optional): array items
• limit(optional): integer(int64)
• offset(optional): integer(int64)
• properties(optional): object properties
  Additional Properties Allowed: additionalProperties
• totalResults(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/CommentBean"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "hasMore":{
            "type":"boolean"
        },
        "count":{
            "type":"integer",
            "format":"int64"
        },
        "limit":{
            "type":"integer",
            "format":"int64"
        },
        "properties":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "offset":{
            "type":"integer",
            "format":"int64"
        }
    },
    "xml":{
        "name":"Comments"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object Comment

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/CommentBean"
    }
}

Nested Schema : properties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : Comment

Type: object

Show Source

• id(optional): integer(int64)
• links(optional): array links
• message(optional): string
• owner(optional): object Owner
• time(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "owner":{
            "$ref":"#/definitions/Owner"
        },
        "time":{
            "type":"integer",
            "format":"int64"
        },
        "message":{
            "type":"string"
        },
        "id":{
            "type":"integer",
            "format":"int64"
        }
    },
    "xml":{
        "name":"Comment"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Owner

Type: object

Show Source

• id(optional): string
• name(optional): string

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "xml":{
        "name":"Owner"
    }
}

Nested Schema : Link

Type: object

Show Source

• href(optional): string
• method(optional): string
• rel(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "method":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

400 Response

Bad Request

Failed to get scenario comments. The scenario ID may be invalid.

500 Response

Internal Server Error.

Back to Top