Discussion

    Discussions can be created in projects and workspaces. As they are specific to workspaces and projects, you won’t be able to access all of the discussions in Slingshot. You can organize discussions in different lists.

    Schema:

    Property Type Attributes
    id string read-only
    modified string read-only
    timestamp double read-only
    created string read-only
    name string min = 1, max = 100
    workspace object <DocumentInfo> read-only
    project object <DocumentInfo> read-only
    discussionList object <DocumentInfo> read-only
    lastMessage object <ChatMessageInfo> read-only

    Example:

    {
    "id": "{123456}",
    "modified": "2023-02-03T11:42:39.0000000",
    "timestamp": 1675424559437.8538,
    "created": "2023-01-27T11:53:13.0000000",
    "name": "Emails",
    "workspace": {
        "id": "{123456}_ws",
        "name": "Support"
    },
    "discussionList": {
        "id": "{123456}",
        "name": "List 2"
    },
    "lastMessage": {
        "id": "{123456}",
        "userId": "{123456}_u",
        "text": "Thanks."
    }
}

    Create a discussion

    Post request for a discussion https://my.slingshotapp.io/v1/discussion

    Required parameters: None

    When you request to create a discussion, the request body will have the following content:

    Property Type Attributes
    name string required, min = 1, max = 100
    discussionList object <DocumentInfo> required

    Possible responses:

    Code Description
    201 (Created) You successfully created a discussion. The newly created discussion will be returned in the response body.
    400 (Bad Request) The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong.
    403 (Forbidden) The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
    404 (Not Found) The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

    Example of a successful request body:

    {
    "name": "Feedback",
    "discussionList": {
        "id": "{123456}",
        "name": "Threads"
    }
}

    Example of a successful response body: { "id": "{123456}", "modified": "2023-02-03T10:11:36.0000000", "timestamp": 1675419096390.1465, "created": "2023-02-03T10:11:36.0000000", "name": "Feedback", "workspace": { "id": "{123456}_ws", "name": "Documentation" }, "discussionList": { "id": "{123456}", "name": "Threads" } }

    Get a discussion

    Get request for a discussion ***https://my.slingshotapp.io/v1/discussions***

    Required parameters: the id of the discussion

    Possible responses:

    Code Description
    200 (Success) You can view the discussion. The requested Discussion will be returned in the response body.
    403 (Forbidden) The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
    404 (Not Found) The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

    Get all discussions for a parent document

    Get all request for discussions https://my.slingshotapp.io/v1/discussions/parent/{id}

    Required parameters: the id of the parent discussion list

    Possible responses:

    Code Description
    200 (Success) You can view all the discussions that are in the parent document. The requested discussions will be returned in the response body.
    403 (Forbidden) The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
    404 (Not Found) The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

    Get discussion messages

    Delete request for a discussion https://my.slingshotapp.io/v1/discussions/{id}/messages

    Required parameters: the id of the discussion

    [!NOTE] In case you don’t set a number of returned messages or a start index, they will be automatically added. The default value for the number of returned messages is 10 and for the start index is 0.

    Possible responses:

    Code Description
    200 (Success) You can view all the messages in the discussion. The requested Discussion messages will be returned to the response body.
    403 (Forbidden) The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
    404 (Not Found) The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

    Send a discussion message

    Send discussion message for discussion https://my.slingshotapp.io/v1/discussions/{id}/send

    Required parameters: the id of the discussion

    When you request to send a discussion message, the request body will have the following content:

    Property Type Attributes
    text string

    Possible responses:

    Code Description
    204 (No Content) The message is sent.
    400 (Bad Request) The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong.
    403 (Forbidden) The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
    404 (Not Found) The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

    Example of a successful request body:

    {
    "text": "I will schedule a meeting for tomorrrow."
}

    Update a discussion

    Patch request for a discussion https://my.slingshotapp.io/v1/discussions/{id}

    Required parameters: the id of the discussion

    When you request to update a discussion, the request body will have the following content

    Property Type Attributes
    name string min = 1, max = 100

    Possible responses:

    Code Description
    200 (Success) The discussion is updated.
    400 (Bad Request) The request was not processed because of missing or malformed parameter(s). Check the error array in the response to get an idea of what went wrong.
    403 (Forbidden) The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
    404 (Not Found) The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.

    Example of a successful request body:

    {
    "name": "Emails"
}

    Example of a successful response body: { "id": "{123456}", "modified": "2023-02-03T11:42:39.0000000", "timestamp": 1675424559437.8538, "created": "2023-01-27T11:53:13.0000000", "name": "Emails", "workspace": { "id": "{123456}_ws", "name": "Support" }, "discussionList": { "id": "{123456}", "name": "List 1" }, "lastMessage": { "id": "{123456}", "userId": "{123456}_u", "text": "We should check this again." } }

    Delete a discussion

    Delete request for a discussion https://my.slingshotapp.io/v1/discussions/{id}

    Required parameters: the id of the specific discussion

    Possible responses:

    Code Description
    204 (No Content) The discussion is deleted.
    403 (Forbidden) The server understands the request, but the request cannot be authorized. This can happen, for example, when you try reading an object without access. No need for re-authentication.
    404 (Not Found) The requested resource cannot be found by the server. This can be, for example, due to a specified object that doesn’t exist.