MasterKeyword object

Fields

Field	Type	Description	Editable
key_name	string
key_title	string
suggestions	string

Filters

Field	Description
id	ID

find master keyword

GET https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/{: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": "master_keywords",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/1"
    },
    "attributes": {
      "key_name": "customer_code",
      "key_title": "",
      "suggestions": [
        "1234"
      ]
    },
    "relationships": {
      "user_infos": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/1/relationships/user_infos",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/1/user_infos"
        }
      }
    }
  }
}

search master keywords

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

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": "master_keywords",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/1"
      },
      "attributes": {
        "key_name": "customer_code",
        "key_title": "",
        "suggestions": [
          "1234"
        ]
      },
      "relationships": {
        "user_infos": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/1/relationships/user_infos",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/1/user_infos"
          }
        }
      }
    }
  ],
  "meta": {
    "record_count": 1
  },
  "links": {
    "first": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords?page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "last": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords?page%5Bnumber%5D=1&page%5Bsize%5D=25"
  }
}

create master keyword

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

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": "master_keywords",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/2"
    },
    "attributes": {
      "key_name": "login_key",
      "key_title": "",
      "suggestions": []
    },
    "relationships": {
      "user_infos": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/2/relationships/user_infos",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/2/user_infos"
        }
      }
    }
  }
}

update master keywords

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

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": "master_keywords",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/1"
    },
    "attributes": {
      "key_name": "customer_code",
      "key_title": "",
      "suggestions": [
        "1234"
      ]
    },
    "relationships": {
      "user_infos": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/1/relationships/user_infos",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/master_keywords/1/user_infos"
        }
      }
    }
  }
}

delete master keyword

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

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

204

Completed 204 No Content