Memo object

Fields

Field	Type	Description	Editable
resource_id	integer
resource_type	string
user_id	integer
text	string
created_at_unix	integer

Filters

Field	Description
id	ID

find memo

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/{: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": "memos",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/1"
    },
    "attributes": {
      "resource_id": 1,
      "resource_type": "Room",
      "user_id": 1,
      "text": "Memo",
      "created_at_unix": 1542679299
    },
    "relationships": {
      "user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/1/relationships/user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/1/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    }
  }
}

search memos

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

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": "memos",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/1"
      },
      "attributes": {
        "resource_id": 1,
        "resource_type": "Room",
        "user_id": 1,
        "text": "Memo",
        "created_at_unix": 1542679299
      },
      "relationships": {
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/1/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/1/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        }
      }
    }
  ],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos?page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "last": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos?page%5Bnumber%5D=1&page%5Bsize%5D=25"
  }
}

create memo

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

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": "2",
    "type": "memos",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/2"
    },
    "attributes": {
      "resource_id": 1,
      "resource_type": "Room",
      "user_id": 1,
      "text": null,
      "created_at_unix": 1542679363
    },
    "relationships": {
      "user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/2/relationships/user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/2/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    }
  }
}

update memos

PUT https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/{: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": "memos",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/1"
    },
    "attributes": {
      "resource_id": 1,
      "resource_type": "Room",
      "user_id": 1,
      "text": "Memo",
      "created_at_unix": 1542679299
    },
    "relationships": {
      "user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/1/relationships/user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/1/user"
        },
        "data": {
          "type": "users",
          "id": "1"
        }
      }
    }
  }
}

delete memo

DELETE https://{YOUR_OKSKY_DOMAIN}/rapi/v1/memos/{: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