Jump to

• Request
• Response

Add Comment

post

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

Adds a comment to the specified scenario ID.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• scenarioId: integer(int64)

  Scenario ID.

Body ()

Comment details.

Root 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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

Scenario comment added successfully.

Body ()

Root 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 add a comment. The scenario ID may be invalid.

500 Response

Internal Server Error.

Back to Top