Linden Lab Official:Inventory API v3

From Second Life Wiki
Revision as of 09:09, 4 October 2013 by Don Linden (talk | contribs)
Jump to navigation Jump to search

Resource Methods Overview

† - Partially Implemented ‡ - Not Implemented
Category /category/{category}{?tid,depth,simulate} GET POST† PUT PATCH COPY MOVE‡ DELETE
CategoryChildren /category/{category}/children{?tid,depth,simulate} GET PUT‡ COPY‡ MOVE‡ DELETE
CategoryLinks /category/{category}/links{?tid,simulate} GET PUT COPY‡ MOVE‡ DELETE
CategoryItems /category/{category}/items{?tid,simulate} GET PUT‡ COPY‡ MOVE‡ DELETE
CategoryCategories /category/{category}/categories{?tid,depth,simulate} GET PUT‡ COPY‡ MOVE‡ DELETE
Item /item/{item}{?tid,simulate} GET PATCH COPY‡ MOVE‡ DELETE

Resources

Category

Description

  • An inventory category.

Path:

  • /category/{category}{?tid,depth,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • depth → Category child depth to retrieve.
    • Validation: ^(\*|[0-9]+)?$
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

Category-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category retrieved successfully

Response Schemas:

categoryResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

categoryChildrenResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
categories
Response Headers
ETag Current value of the entity tag for the requested variant.
304

Description

  • Not modified

Response Schemas: string

Response Headers
ETag Current value of the entity tag for the requested variant.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-POST

Implementation Status

  • PARTIAL

Description

  • Create inventory in category.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas
newEmbeddedChildren
items (optional)

array

links (optional)

array

categories (optional)

array

Status Codes
201

Description

  • Inventory created

Response Schemas:

categoryNewChildrenResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
categories
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
links
_created_categories
_created_items
_updated_category_versions
Response Headers
Location The URL of the category children containing the created inventory.
400

Description

  • Invalid request

Response Schemas:

errorInvalidLinksShape
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

invalid_linked_ids (optional)
error_code

integer

errorInvalidRequest
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

409

Description

  • Duplicate transaction.

Response Schemas:

errorDuplicateTransaction
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

transaction_id

string

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-PUT

Implementation Status

  • COMPLETE

Description

  • Create and retrieve a 'special' category.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category created

Response Schemas:

categoryNewResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_created_categories
_updated_category_versions
Response Headers
Location The URL of the created category
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

409

Description

  • Category already exists

Response Schemas:

categoryResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-PATCH

Implementation Status

  • COMPLETE

Description

  • Modify a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas
modifyCategory
name

string

Status Codes
200

Description

  • Category modified successfully

Response Schemas:

categoryModifyResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_updated_categories
_update_result (optional)
server_response (optional)

string

fault_code (optional)

integer

code

integer

message

string

success
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
400

Description

  • Invalid request

Response Schemas:

errorInvalidCategoryRequest
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-COPY

Implementation Status

  • COMPLETE

Description

  • Copy a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id or 'special' category.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category copied successfully

Response Schemas:

categoryCopyResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
categories
_removed_items
_top_category_id

uuid

_created_items
_moved_items
_created_categories
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

409

Description

  • Duplicate transaction.

Response Schemas:

errorDuplicateTransaction
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

transaction_id

string

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-MOVE

Implementation Status

  • NONE

Description

  • Move a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category moved successfully

Response Schemas:

categoryMoveResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_updated_categories
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Category-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category deleted successfully

Response Schemas:

categoryDeleteResponse
_update_result (optional)
server_response (optional)

string

fault_code (optional)

integer

code

integer

message

string

success
_attachments_removed
_active_gestures_removed
_broken_links_removed
_total_items_removed

integer

_wearables_removed
_category_items_removed
_categories_removed
_updated_category_versions
410

Description

  • Category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren

Description

  • Children in an inventory category.

Path:

  • /category/{category}/children{?tid,depth,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • depth → Category child depth to retrieve.
    • Validation: ^(\*|[0-9]+)?$
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

CategoryChildren-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve children in a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category children retrieved successfully

Response Schemas:

categoryChildrenResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
categories
Response Headers
ETag Current value of the entity tag for the requested variant.
304

Description

  • Not modified

Response Schemas: string

Response Headers
ETag Current value of the entity tag for the requested variant.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren-PUT

Implementation Status

  • NONE

Description

  • Replace category children.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas
newEmbeddedChildren
items (optional)

array

links (optional)

array

categories (optional)

array

Status Codes
201

Description

  • Category children replaced

Response Schemas:

categoryChildrenReplaceResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
categories
_attachments_removed
_active_gestures_removed
_broken_links_removed
_total_items_removed

integer

_created_items
_wearables_removed
_created_categories
_categories_removed
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the replaced category children.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren-COPY

Implementation Status

  • NONE

Description

  • Copy category children
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id or 'special' category.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category children copied successfully

Response Schemas:

categoryCopyResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
categories
_removed_items
_top_category_id

uuid

_created_items
_moved_items
_created_categories
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren-MOVE

Implementation Status

  • NONE

Description

  • Move category children
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category children moved successfully

Response Schemas:

categoryChildrenMoveResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
categories
_updated_items
_updated_categories
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryChildren-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete category children
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category children deleted successfully

Response Schemas:

categoryDeleteResponse
_update_result (optional)
server_response (optional)

string

fault_code (optional)

integer

code

integer

message

string

success
_attachments_removed
_active_gestures_removed
_broken_links_removed
_total_items_removed

integer

_wearables_removed
_category_items_removed
_categories_removed
_updated_category_versions
410

Description

  • Category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryLinks

Description

  • Links in an inventory category.

Path:

  • /category/{category}/links{?tid,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

CategoryLinks-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve links in a category
Status Codes

Description

  • Category links retrieved successfully

Response Schemas:

categoryLinksResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
links

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

CategoryLinks-PUT

Implementation Status

  • COMPLETE

Description

  • Replace category links.
Request Schemas

array

Status Codes

Description

  • Category links replaced

Response Schemas:

categoryLinksReplaceResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
links
_linked_ids
_updated_items
_category_items_removed
_created_items
_updated_category_versions
Response Headers
Location The URL of the replaced category links.

Description

  • Invalid request

Response Schemas:

errorInvalidLinksShape
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

invalid_linked_ids (optional)
error_code

integer

errorInvalidRequest
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

CategoryLinks-COPY

Implementation Status

  • NONE

Description

  • Copy category links
Request Headers
Destination Destination category_id or 'special' category.
Status Codes

Description

  • Category links copied successfully

Response Schemas:

categoryLinksCopyResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
links
_created_items
_updated_category_versions
Response Headers
Location The URL of the copied inventory.

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

CategoryLinks-MOVE

Implementation Status

  • NONE

Description

  • Move category links
Request Headers
Destination Destination category_id.
Status Codes

Description

  • Category links moved successfully

Response Schemas:

categoryLinksMoveResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
links
_updated_items
_updated_category_versions
Response Headers
Location The URL of the moved inventory.

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

CategoryLinks-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete category links
Status Codes

Description

  • Category links deleted successfully

Response Schemas:

categoryLinksDeleteResponse
_category_items_removed
_updated_category_versions

Description

  • Category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

CategoryItems

Description

  • Items in an inventory category.

Path:

  • /category/{category}/items{?tid,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

CategoryItems-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve items in a category
Status Codes
200

Description

  • Category items retrieved successfully

Response Schemas:

categoryItemsResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
Response Headers
ETag Current value of the entity tag for the requested variant.
304

Description

  • Not modified

Response Schemas: string

Response Headers
ETag Current value of the entity tag for the requested variant.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryItems-PUT

Implementation Status

  • NONE

Description

  • Replace category items.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas
replaceCategoryItems
items (optional)

array

links (optional)

array

Status Codes
201

Description

  • Category items replaced

Response Schemas:

categoryItemsReplaceResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
_attachments_removed
_linked_ids
_active_gestures_removed
_broken_links_removed
_created_items
_wearables_removed
_updated_items
_category_items_removed
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the replaced category items.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryItems-COPY

Implementation Status

  • NONE

Description

  • Copy category items
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id or 'special' category.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category items copied successfully

Response Schemas:

categoryItemsCopyResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
_created_items
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryItems-MOVE

Implementation Status

  • NONE

Description

  • Move category items
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category items moved successfully

Response Schemas:

categoryItemsMoveResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
_updated_items
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryItems-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete category items
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category items deleted successfully

Response Schemas:

categoryItemsDeleteResponse
_attachments_removed
_active_gestures_removed
_broken_links_removed
_wearables_removed
_category_items_removed
_updated_category_versions
410

Description

  • Category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories

Description

  • Categories in an inventory category.

Path:

  • /category/{category}/categories{?tid,depth,simulate}

Parameters

  • category → Category UUID or 'special' category name, e.g. "current".
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
    • Validation: ^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$
    • Validation: ^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$
  • tid → Transaction ID.
  • depth → Category child depth to retrieve.
    • Validation: ^(\*|[0-9]+)?$
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

CategoryCategories-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve categories in a category
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category categories retrieved successfully

Response Schemas:

categoryCategoriesResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
categories
Response Headers
ETag Current value of the entity tag for the requested variant.
304

Description

  • Not modified

Response Schemas: string

Response Headers
ETag Current value of the entity tag for the requested variant.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories-PUT

Implementation Status

  • NONE

Description

  • Replace category categories.
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Request Schemas

array

Status Codes
201

Description

  • Category categories replaced

Response Schemas:

categoryChildrenReplaceResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
categories
_attachments_removed
_active_gestures_removed
_broken_links_removed
_total_items_removed

integer

_created_items
_wearables_removed
_created_categories
_categories_removed
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the replaced category categories.
404

Description

  • Category not found

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories-COPY

Implementation Status

  • NONE

Description

  • Copy category categories
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id or 'special' category.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
201

Description

  • Category categories copied successfully

Response Schemas:

categoryCopyResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
items
links
categories
_removed_items
_top_category_id

uuid

_created_items
_moved_items
_created_categories
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories-MOVE

Implementation Status

  • NONE

Description

  • Move category categories
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
Destination Destination category_id.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category categories moved successfully

Response Schemas:

categoryCategoriesMoveResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
category (optional)
href

string

name (optional)
parent
href

string

name (optional)
links
href

string

name (optional)
items
href

string

name (optional)
self
href

string

name (optional)
children
href

string

name (optional)
categories (optional)
href

string

name (optional)
_base_uri

string

name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_embedded
categories
_updated_categories
_updated_category_versions
Response Headers
ETag Current value of the entity tag for the requested variant.
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

410

Description

  • Source category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

CategoryCategories-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete category categories
Request Headers
If-None-Match (optional) Only process request if none of the supplied entity tags matches resource.
If-Match (optional) Only process request if any supplied entity tags matches resource.
Status Codes
200

Description

  • Category categories deleted successfully

Response Schemas:

categoryDeleteResponse
_update_result (optional)
server_response (optional)

string

fault_code (optional)

integer

code

integer

message

string

success
_attachments_removed
_active_gestures_removed
_broken_links_removed
_total_items_removed

integer

_wearables_removed
_category_items_removed
_categories_removed
_updated_category_versions
410

Description

  • Category gone

Response Schemas:

errorCategoryGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

412

Description

  • Precondition failed

Response Schemas:

errorPreconditionFailed
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

etags

array

etag

string

error_code

integer

condition

string

Response Headers
ETag Current value of the entity tag for the requested variant.

Item

Description

  • An inventory item.

Path:

  • /item/{item}{?tid,simulate}

Parameters

  • tid → Transaction ID.
  • item → Item UUID
    • Validation: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
  • simulate → Whether or not to skip writing back results.
    • Validation: ^(0|1|true|false)?$

Item-GET

Implementation Status

  • COMPLETE

Description

  • Retrieve an item
Status Codes
200

Description

  • Item retrieved successfully

Response Schemas:

itemResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
_base_uri

string

asset_id

uuid

inv_type

integer

name

string

sale_info
sale_price

integer

sale_type

integer

created_at

integer

parent_id (optional)

uuid

flags

integer

agent_id

uuid

item_id

uuid

permissions
base_mask

integer

group_mask

integer

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer

owner_mask

integer

group_id

uuid

everyone_mask

integer

type

integer

desc

string

linkResponse
_base_uri

string

_links
item
href

string

name (optional)
category
href

string

name (optional)
self
href

string

name (optional)
parent
href

string

name (optional)
_embedded
item
asset_id

uuid

inv_type

integer

name

string

sale_info
sale_price

integer

sale_type

integer

created_at

integer

parent_id (optional)

uuid

flags

integer

agent_id

uuid

item_id

uuid

permissions
base_mask

integer

group_mask

integer

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer

owner_mask

integer

group_id

uuid

everyone_mask

integer

type

integer

desc

string

_links
self
href

string

name (optional)
parent
href

string

name (optional)
category
name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_links
self
href

string

name (optional)
parent
href

string

name (optional)
_broken
linked_id

uuid

name

string

created_at
parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer

type

integer

desc

string

404

Description

  • Item not found

Response Schemas:

errorItemNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

item_id (optional)

uuid

error_code

integer

Item-PATCH

Implementation Status

  • COMPLETE

Description

  • Modify an item
Request Schemas
modifyItem
asset_id (optional)

uuid

name (optional)

string

sale_info (optional)
sale_price (optional)

integer

sale_type (optional)

integer

flags (optional)

integer

desc (optional)

string

hash_id (optional)

uuid

permissions (optional)
owner_mask (optional)

integer

everyone_mask (optional)

integer

next_owner_mask (optional)

integer

group_mask (optional)

integer

modifyLink
linked_id (optional)

uuid

name (optional)

string

desc (optional)

string

Status Codes
200

Description

  • Item modified successfully

Response Schemas:

itemModifyResponse
_links
self
href

string

name (optional)
parent
href

string

name (optional)
_base_uri

string

asset_id

uuid

inv_type

integer

name

string

sale_info
sale_price

integer

sale_type

integer

created_at

integer

parent_id (optional)

uuid

flags

integer

agent_id

uuid

item_id

uuid

permissions
base_mask

integer

group_mask

integer

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer

owner_mask

integer

group_id

uuid

everyone_mask

integer

type

integer

desc

string

_updated_items
_update_result (optional)
server_response (optional)

string

fault_code (optional)

integer

code

integer

message

string

success
_updated_category_versions
linkModifyResponse
_base_uri

string

_links
item
href

string

name (optional)
category
href

string

name (optional)
self
href

string

name (optional)
parent
href

string

name (optional)
_embedded
item
asset_id

uuid

inv_type

integer

name

string

sale_info
sale_price

integer

sale_type

integer

created_at

integer

parent_id (optional)

uuid

flags

integer

agent_id

uuid

item_id

uuid

permissions
base_mask

integer

group_mask

integer

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer

owner_mask

integer

group_id

uuid

everyone_mask

integer

type

integer

desc

string

_links
self
href

string

name (optional)
parent
href

string

name (optional)
category
name

string

type_default

integer

parent_id

uuid

version

integer

agent_id

uuid

category_id

uuid

_links
self
href

string

name (optional)
parent
href

string

name (optional)
_broken
linked_id

uuid

name

string

created_at
parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer

type

integer

desc

string

_updated_items
_update_result (optional)
server_response (optional)

string

fault_code (optional)

integer

code

integer

message

string

success
_updated_category_versions
400

Description

  • Invalid request

Response Schemas:

errorInvalidItemRequest
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

item_id (optional)

uuid

error_code

integer

404

Description

  • Item not found

Response Schemas:

errorItemNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

item_id (optional)

uuid

error_code

integer

Item-COPY

Implementation Status

  • NONE

Description

  • Copy an item
Request Headers
Destination Destination category_id or 'special' category.
Status Codes
201

Description

  • Item copied successfully

Response Schemas:

itemCopyResponse
asset_id

uuid

inv_type

integer

name

string

sale_info
sale_price

integer

sale_type

integer

created_at

integer

parent_id (optional)

uuid

flags

integer

agent_id

uuid

item_id

uuid

permissions
base_mask

integer

group_mask

integer

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer

owner_mask

integer

group_id

uuid

everyone_mask

integer

type

integer

desc

string

_created_items
_updated_category_versions
linkCopyResponse
linked_id

uuid

name

string

created_at
parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer

type

integer

desc

string

_created_items
_updated_category_versions
Response Headers
Location The URL of the copied inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

410

Description

  • Source item gone

Response Schemas:

errorItemGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

item_id

uuid

error_code

integer

Item-MOVE

Implementation Status

  • NONE

Description

  • Move an item
Request Headers
Destination Destination category_id or 'special' category.
Status Codes
200

Description

  • Item moved successfully

Response Schemas:

itemMoveResponse
asset_id

uuid

inv_type

integer

name

string

sale_info
sale_price

integer

sale_type

integer

created_at

integer

parent_id (optional)

uuid

flags

integer

agent_id

uuid

item_id

uuid

permissions
base_mask

integer

group_mask

integer

last_owner_id

uuid

owner_id

uuid

creator_id

uuid

next_owner_mask

integer

owner_mask

integer

group_id

uuid

everyone_mask

integer

type

integer

desc

string

_updated_items
_updated_category_versions
linkMoveResponse
linked_id

uuid

name

string

created_at
parent_id

uuid

agent_id

uuid

item_id

uuid

inv_type

integer

type

integer

desc

string

_updated_items
_updated_category_versions
Response Headers
Location The URL of the moved inventory.
403

Description

  • Permissions check failed.

Response Schemas:

errorInvalidPermissions
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

404

Description

  • Destination category not found.

Response Schemas:

errorCategoryNotFound
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

category_id (optional)

uuid

error_code

integer

410

Description

  • Source item gone

Response Schemas:

errorItemGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

item_id

uuid

error_code

integer

Item-DELETE

Implementation Status

  • COMPLETE

Description

  • Delete an item
Status Codes
200

Description

  • Item deleted successfully

Response Schemas:

itemDeleteResponse
_attachments_removed
_update_result (optional)
server_response (optional)

string

fault_code (optional)

integer

code

integer

message

string

success
_active_gestures_removed
_broken_links_removed
_wearables_removed
_category_items_removed
_updated_category_versions
410

Description

  • Item gone

Response Schemas:

errorItemGone
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

item_id

uuid

error_code

integer

Global Response Status Codes

400

Description

  • Invalid request

Response Schemas:

errorGeneral
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

415

Description

  • Unsupported media type

Response Schemas:

errorGeneral
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

500

Description

  • Internal Error

Response Schemas:

errorGeneral
error_line_number (optional)

integer

error_filename (optional)

string

error_description

string

error_function (optional)

string

error_code

integer

Global Request Headers

Content-Type (optional) Content type of request payload. Generally application/llsd+xml or application/json.
Accept-Encoding (optional) Preferred response encoding (e.g. 'gzip')
Accept (optional) Preferred response Content-Type. Generally application/llsd+xml or application/json.
Cache-Control (optional) Directives to caching mechanisms.

Global Response Headers

Vary Indicates the set of request-header fields that determines request variants. Used by caching mechanisms.
Content-Encoding (optional) Response encoding (e.g. 'gzip')
Content-Type (optional) Content type of response payload. Generally application/llsd+xml or application/json.
Content-Location (optional) Canonical location of requested resource.
Cache-Control (optional) Directives to caching mechanisms.
Retrieved from "https://wiki.secondlife.com/w/index.php?title=Linden_Lab_Official:Inventory_API_v3&oldid=1182186"