Map Item Resource

Example JSON API response

Create a MapItem

Fetch a MapItem resource

GET

https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}

パラメーター

Names in None format

Names in None format
`service_sid` 必須	GET sid_like<IS> Not PII The SID of the Sync Service with the Sync Map Item resource to fetch.
`map_sid` 必須	GET sid_like<MP> Not PII The SID of the Sync Map with the Sync Map Item resource to fetch. Can be the Sync Map's `sid` or its `unique_name`.
`key` 必須	GET 文字列 PII MTL: 30 DAYS The `key` value of the Sync Map Item resource to fetch.

service_sid

必須

GET sid_like<IS> Not PII

The SID of the Sync Service with the Sync Map Item resource to fetch.

map_sid

必須

GET sid_like<MP> Not PII

The SID of the Sync Map with the Sync Map Item resource to fetch. Can be the Sync Map's sid or its unique_name.

key

必須

GET 文字列 PII MTL: 30 DAYS

The key value of the Sync Map Item resource to fetch.

例 1

Example JSON API response

Request a MapItem by the key you defined when you created the item

Fetch a MapItem

Request a MapItem by the key you defined when you created the item

Read all MapItem resources

GET

https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Items

Map Item read access is performed using the key that provided as an arbitrary string to identify the item.

By default, this will return the first 50 Map items. Supply a PageSize parameter to fetch up to 100 items at once. See paging for more information.

パラメーター

Names in None format
`service_sid` 必須	GET sid_like<IS> Not PII The SID of the Sync Service with the Map Item resources to read.
`map_sid` 必須	GET sid_like<MP> Not PII The SID of the Sync Map with the Sync Map Item resource to fetch. Can be the Sync Map's `sid` or its `unique_name`.
`order` オプション	GET enum:query_result_order Not PII How to order the Map Items returned by their `key` value. Can be: `asc` (ascending) or `desc` (descending) and the default is ascending. Map Items are ordered lexicographically by Item key.
`from` オプション	GET 文字列 Not PII The `key` of the first Sync Map Item resource to read. See also `bounds`.
`bounds` オプション	GET enum:query_from_bound_type Not PII Whether to include the Map Item referenced by the `from` parameter. Can be: `inclusive` to include the Map Item referenced by the `from` parameter or `exclusive` to start with the next Map Item. The default value is `inclusive`.

例 1

Example JSON API response

Read all MapItems

例 2

Example JSON API response

Read: Query a Map with filters

Update a MapItem resource

post

https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}

Map Item update access is performed using the key that provided as an arbitrary string to identify the item.

パラメーター

Names in None format
`service_sid` 必須	post sid_like<IS> Not PII The SID of the Sync Service with the Sync Map Item resource to update.
`map_sid` 必須	post sid_like<MP> Not PII The SID of the Sync Map with the Sync Map Item resource to update. Can be the Sync Map's `sid` or its `unique_name`.
`key` 必須	post 文字列 PII MTL: 30 DAYS The `key` value of the Sync Map Item resource to update.
`data` オプション	post オブジェクト PII MTL: 7 DAYS A JSON string that represents an arbitrary, schema-less object that the Map Item stores. Can be up to 16KB in length.
`ttl` オプション	post integer Not PII An alias for `item_ttl`. If both parameters are provided, this value is ignored.
`item_ttl` オプション	post integer Not PII How long, in seconds, before the Map Item expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the Map Item does not expire. The Map Item will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.
`collection_ttl` オプション	post integer Not PII How long, in seconds, before the Map Item's parent Sync Map expires (time-to-live) and is deleted. Can be an integer from 0 to 31,536,000 (1 year). The default value is `0`, which means the parent Sync Map does not expire. This parameter can only be used when the Map Item's `data` or `ttl` is updated in the same request. The Sync Map will be deleted automatically after it expires, but there can be a delay between the expiration time and the resources's deletion.

例 1

Example JSON API response

Update a MapItem

Delete a MapItem resource

削除する

https://sync.twilio.com/v1/Services/{ServiceSid}/Maps/{MapSid}/Items/{Key}

Permanently delete a specific item from an existing Map.

パラメーター

Names in None format

Names in None format
`service_sid` 必須	削除する sid_like<IS> Not PII The SID of the Sync Service with the Sync Map Item resource to delete.
`map_sid` 必須	削除する sid_like<MP> Not PII The SID of the Sync Map with the Sync Map Item resource to delete. Can be the Sync Map's `sid` or its `unique_name`.
`key` 必須	削除する文字列 PII MTL: 30 DAYS The `key` value of the Sync Map Item resource to delete.

service_sid

必須

削除する sid_like<IS> Not PII

The SID of the Sync Service with the Sync Map Item resource to delete.

map_sid

必須

削除する sid_like<MP> Not PII

The SID of the Sync Map with the Sync Map Item resource to delete. Can be the Sync Map's sid or its unique_name.

key

必須

削除する文字列 PII MTL: 30 DAYS

The key value of the Sync Map Item resource to delete.

例 1