Suggestion object

Fields

Field	Type	Description	Editable
suggestion_messages_data	array

Filters

Field	Description
id	ID
room_id	RoomのID

find suggestion

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/{:id}

Headers

Name	Type	Description
X-Access-Token	string	set you access token
Content-Type	string	application/vnd.api+json
Accept	string	application/vnd.api+json

200

HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1",
    "type": "suggestions",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1"
    },
    "attributes": {
      "suggestion_messages_data": [
        {
          "kind": "text",
          "content": "Content",
          "settings": {}
        }
      ]
    },
    "relationships": {
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      }
    }
  }
}

search suggestions

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions

Headers

Name	Type	Description
X-Access-Token	string	set you access token
Content-Type	string	application/vnd.api+json
Accept	string	application/vnd.api+json

200

{
  "data": [
    {
      "id": "1",
      "type": "suggestions",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1"
      },
      "attributes": {
        "suggestion_messages_data": [
          {
            "kind": "text",
            "content": "Content",
            "settings": {}
          }
        ]
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1/room"
          },
          "data": {
            "type": "rooms",
            "id": "1"
          }
        }
      }
    }
  ],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions?page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "last": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions?page%5Bnumber%5D=1&page%5Bsize%5D=25"
  }
}

create suggestion

POST https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions

Headers

Name	Type	Description
Accept	string	application/vnd.api+json
Content-Type	string	application/vnd.api+json
X-Access-Token	string	set your access token

Request Body

Name	Type	Description
data	object

200

{
  "data": {
    "id": "1",
    "type": "suggestions",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1"
    },
    "attributes": {
      "suggestion_messages_data": [
        {
          "kind": "text",
          "content": "test"
        }
      ]
    },
    "relationships": {
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      }
    }
  }
}

update suggestions

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/{:id}

Headers

Name	Type	Description
X-Access-Token	string	set you access token
Content-Type	string	application/vnd.api+json
Accept	string	application/vnd.api+json

Request Body

Name	Type	Description
data	object

200

{
  "data": {
    "id": "1",
    "type": "suggestions",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1"
    },
    "attributes": {
      "suggestion_messages_data": [
        {
          "kind": "text",
          "content": "test"
        }
      ]
    },
    "relationships": {
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/1/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      }
    }
  }
}

delete suggestion

DELETE https://{YOUR_OKSKY_DOMAIN}/rapi/v1/suggestions/{:id}

Headers

Name	Type	Description
X-Access-Token	string	set you access token
Content-Type	string	application/vnd.api+json
Accept	string	application/vnd.api+json

204

Completed 204 No Content