Difference between revisions of "Linden Lab Official:Inventory API v3"

From Second Life Wiki
Jump to navigation Jump to search
(Created page with "{{TOCright}} == Overview == {| class="lltable" border=1 |+Resource methods |- |- ! scope="row" align="left"| Category | ''/category/{category}{?tid,depth,simulat…")
 
Line 1: Line 1:
{{TOCright}}
{{TOCright}}


== Overview ==
== Resource Methods Overview ==
{| class="lltable" border=1
{| class="lltable" border=1
|+Resource methods
|+ align="bottom" style="background-color: #333333;" |''<span style="color: #FFFF99;"> &Dagger; - Not Implemented<span> <span style="color: #FFFFFF;">&dagger; - Partially Implemented</span>''
|-
|-
|-
|-
! scope="row" align="left"| [[#Category | Category]]
! scope="row" align="left"| [[#Category | Category]]
| ''/category/{category}{?tid,depth,simulate}''
| ''/category/{category}{?tid,depth,simulate}''
| [[#Category-GET | GET]]
| [[#Category-GET | <span style="background-color: #3A87AD;
| [[#Category-MOVE | MOVE]]
border-radius: 3px 3px 3px 3px;
| [[#Category-PATCH | PATCH]]
display: inline-block;
| [[#Category-PUT | PUT]]
color: #FFFFFF;
| [[#Category-POST | POST]]
font-weight: bold;
| [[#Category-COPY | COPY]]
padding: 2px 4px;">GET</span>]]
| [[#Category-DELETE | DELETE]]
| [[#Category-POST | <span style="background-color: #468847;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">POST&dagger;</span>]]
| [[#Category-PUT | <span style="background-color: #F89406;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">PUT</span>]]
| [[#Category-PATCH | <span style="background-color: #0694F8;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">PATCH</span>]]
| [[#Category-COPY | <span style="background-color: #333333;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">COPY</span>]]
| [[#Category-MOVE | <span style="background-color: #999999;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">MOVE&Dagger;</span>]]
| [[#Category-DELETE | <span style="background-color: #B94A48;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">DELETE</span>]]
|-
|-
! scope="row" align="left"| [[#CategoryChildren | CategoryChildren]]
! scope="row" align="left"| [[#CategoryChildren | CategoryChildren]]
| ''/category/{category}/children{?tid,depth,simulate}''
| ''/category/{category}/children{?tid,depth,simulate}''
| [[#CategoryChildren-GET | GET]]
| [[#CategoryChildren-GET | <span style="background-color: #3A87AD;
| [[#CategoryChildren-MOVE | MOVE]]
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">GET</span>]]
|
|
| [[#CategoryChildren-PUT | PUT]]
| [[#CategoryChildren-PUT | <span style="background-color: #F89406;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">PUT&Dagger;</span>]]
|
|
| [[#CategoryChildren-COPY | COPY]]
| [[#CategoryChildren-COPY | <span style="background-color: #333333;
| [[#CategoryChildren-DELETE | DELETE]]
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">COPY&Dagger;</span>]]
| [[#CategoryChildren-MOVE | <span style="background-color: #999999;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">MOVE&Dagger;</span>]]
| [[#CategoryChildren-DELETE | <span style="background-color: #B94A48;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">DELETE</span>]]
|-
|-
! scope="row" align="left"| [[#CategoryLinks | CategoryLinks]]
! scope="row" align="left"| [[#CategoryLinks | CategoryLinks]]
| ''/category/{category}/links{?tid,simulate}''
| ''/category/{category}/links{?tid,simulate}''
| [[#CategoryLinks-GET | GET]]
| [[#CategoryLinks-GET | <span style="background-color: #3A87AD;
| [[#CategoryLinks-MOVE | MOVE]]
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">GET</span>]]
|
|
| [[#CategoryLinks-PUT | PUT]]
| [[#CategoryLinks-PUT | <span style="background-color: #F89406;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">PUT</span>]]
|
|
| [[#CategoryLinks-COPY | COPY]]
| [[#CategoryLinks-COPY | <span style="background-color: #333333;
| [[#CategoryLinks-DELETE | DELETE]]
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">COPY&Dagger;</span>]]
| [[#CategoryLinks-MOVE | <span style="background-color: #999999;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">MOVE&Dagger;</span>]]
| [[#CategoryLinks-DELETE | <span style="background-color: #B94A48;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">DELETE</span>]]
|-
|-
! scope="row" align="left"| [[#CategoryItems | CategoryItems]]
! scope="row" align="left"| [[#CategoryItems | CategoryItems]]
| ''/category/{category}/items{?tid,simulate}''
| ''/category/{category}/items{?tid,simulate}''
| [[#CategoryItems-GET | GET]]
| [[#CategoryItems-GET | <span style="background-color: #3A87AD;
| [[#CategoryItems-MOVE | MOVE]]
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">GET</span>]]
|
|
| [[#CategoryItems-PUT | PUT]]
| [[#CategoryItems-PUT | <span style="background-color: #F89406;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">PUT&Dagger;</span>]]
|
|
| [[#CategoryItems-COPY | COPY]]
| [[#CategoryItems-COPY | <span style="background-color: #333333;
| [[#CategoryItems-DELETE | DELETE]]
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">COPY&Dagger;</span>]]
| [[#CategoryItems-MOVE | <span style="background-color: #999999;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">MOVE&Dagger;</span>]]
| [[#CategoryItems-DELETE | <span style="background-color: #B94A48;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">DELETE</span>]]
|-
|-
! scope="row" align="left"| [[#CategoryCategories | CategoryCategories]]
! scope="row" align="left"| [[#CategoryCategories | CategoryCategories]]
| ''/category/{category}/categories{?tid,depth,simulate}''
| ''/category/{category}/categories{?tid,depth,simulate}''
| [[#CategoryCategories-GET | GET]]
| [[#CategoryCategories-GET | <span style="background-color: #3A87AD;
| [[#CategoryCategories-MOVE | MOVE]]
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">GET</span>]]
|
|
| [[#CategoryCategories-PUT | PUT]]
| [[#CategoryCategories-PUT | <span style="background-color: #F89406;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">PUT&Dagger;</span>]]
|
|
| [[#CategoryCategories-COPY | COPY]]
| [[#CategoryCategories-COPY | <span style="background-color: #333333;
| [[#CategoryCategories-DELETE | DELETE]]
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">COPY&Dagger;</span>]]
| [[#CategoryCategories-MOVE | <span style="background-color: #999999;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">MOVE&Dagger;</span>]]
| [[#CategoryCategories-DELETE | <span style="background-color: #B94A48;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">DELETE</span>]]
|-
|-
! scope="row" align="left"| [[#Item | Item]]
! scope="row" align="left"| [[#Item | Item]]
| ''/item/{item}{?tid,simulate}''
| ''/item/{item}{?tid,simulate}''
| [[#Item-GET | GET]]
| [[#Item-GET | <span style="background-color: #3A87AD;
| [[#Item-MOVE | MOVE]]
border-radius: 3px 3px 3px 3px;
| [[#Item-PATCH | PATCH]]
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">GET</span>]]
|
|
|
|
| [[#Item-COPY | COPY]]
| [[#Item-PATCH | <span style="background-color: #0694F8;
| [[#Item-DELETE | DELETE]]
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">PATCH</span>]]
| [[#Item-COPY | <span style="background-color: #333333;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">COPY&Dagger;</span>]]
| [[#Item-MOVE | <span style="background-color: #999999;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFF99;
font-weight: bold;
padding: 2px 4px;">MOVE&Dagger;</span>]]
| [[#Item-DELETE | <span style="background-color: #B94A48;
border-radius: 3px 3px 3px 3px;
display: inline-block;
color: #FFFFFF;
font-weight: bold;
padding: 2px 4px;">DELETE</span>]]
|}
|}
== Resources ==
== Resources ==
Line 84: Line 244:
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
<hr>
<hr>
==== Category-GET ====
==== <div id="Category-GET">GET</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
Description
* '''Retrieve a category'''
* '''Retrieve a category'''
Line 98: Line 260:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== Category-GET-200 ======
====== <div id="Category-GET-200">200</div> ======
Description
Description
*  '''Category retrieved successfully'''
*  '''Category retrieved successfully'''
Line 434: Line 596:
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|}
|}
====== Category-GET-404 ======
====== <div id="Category-GET-304">304</div> ======
Description
*  '''Not modified'''
Response Schemas:
string
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
====== <div id="Category-GET-404">404</div> ======
Description
Description
*  '''Category not found'''
*  '''Category not found'''
Line 466: Line 640:
integer
integer
|}
|}
====== Category-GET-304 ======
====== <div id="Category-GET-412">412</div> ======
Description
*  '''Not modified'''
Response Schemas:
string
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
====== Category-GET-412 ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 526: Line 688:
|}
|}
<hr>
<hr>
==== Category-MOVE ====
==== <div id="Category-POST">POST</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #F89406;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">PARTIAL</code>'''
Description
Description
* '''Move a category'''
* '''Create inventory in category.'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 535: Line 699:
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| Destination
| ''Destination category_id.''
|-
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
| ''Only process request if any supplied entity tags matches resource.''
|}
===== Request Schemas =====
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">newEmbeddedChildren</code>
|-
|-
! scope="row" align="left"| items <small><em>(optional)</em></small>
|
array
|-
! scope="row" align="left"| links <small><em>(optional)</em></small>
|
array
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
array
|}
|}
===== Status Codes =====
===== Status Codes =====
====== Category-MOVE-200 ======
====== <div id="Category-POST-201">201</div> ======
Description
Description
*  '''Category moved successfully'''
*  '''Inventory created'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryMoveResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryNewChildrenResponse</code>
|-
|-
|-
|-
Line 702: Line 880:
uuid
uuid
|-
|-
! scope="row" align="left"| _updated_categories
! scope="row" align="left"| _embedded
|
|
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| items
|
|
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| links
|
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| categories
| ''Current value of the entity tag for the requested variant.''
|
|}
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| _links
| ''The URL of the moved inventory.''
|
|}
====== Category-MOVE-404 ======
Description
*  '''Destination category not found.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| self
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|-
! scope="row" align="left"| parent
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| category <small><em>(optional)</em></small>
|
|
integer
|}
====== Category-MOVE-403 ======
Description
*  '''Permissions check failed.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| parent
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|}
====== Category-MOVE-412 ======
|-
Description
! scope="row" align="left"| links
*  '''Precondition failed'''
|
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| items
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| etags
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
array
|}
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| self
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| condition
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
! scope="row" align="left"| children
! scope="row" align="left"| ETag
|
| ''Current value of the entity tag for the requested variant.''
|}
====== Category-MOVE-410 ======
Description
*  '''Source category gone'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| error_code
|
|
integer
|}
|}
<hr>
==== Category-PATCH ====
Description
* '''Modify a category'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
|}
===== Request Schemas =====
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">modifyCategory</code>
|-
|-
! scope="row" align="left"| _base_uri
|
string
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| name
|
|
string
string
|}
===== Status Codes =====
====== Category-PATCH-200 ======
Description
*  '''Category modified successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryModifyResponse</code>
|-
|-
! scope="row" align="left"| type_default
|
integer
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| parent_id
|
|
{| class="lltable" border=1
uuid
|-
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| href
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id
|
|
|}
uuid
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| _embedded
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| links
|
|
string
|}
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _created_categories
|
|
|}
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| _created_items
|
|-
! scope="row" align="left"| _updated_category_versions
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| Location
|
| ''The URL of the category children containing the created inventory.''
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|}
|-
====== <div id="Category-POST-400">400</div> ======
! scope="row" align="left"| parent
Description
|
*  '''Invalid request'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidLinksShape</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| invalid_linked_ids <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| error_code
|
|
integer
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidRequest</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
integer
|}
|}
====== <div id="Category-POST-404">404</div> ======
Description
*  '''Category not found'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
! scope="row" align="left"| children
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
|}
uuid
|-
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
integer
|}
====== <div id="Category-POST-409">409</div> ======
Description
*  '''Duplicate transaction.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorDuplicateTransaction</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|}
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| error_description
|
|
string
string
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| error_code
|
|
integer
integer
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| transaction_id
|
|
uuid
string
|}
====== <div id="Category-POST-412">412</div> ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
uuid
string
|-
|-
! scope="row" align="left"| category_id
! scope="row" align="left"| error_description
|
|
uuid
string
|-
|-
! scope="row" align="left"| _updated_categories
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
string
|-
|-
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
! scope="row" align="left"| etags
|
|
{| class="lltable" border=1
array
|-
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
integer
integer
|-
|-
! scope="row" align="left"| code
! scope="row" align="left"| condition
|
integer
|-
! scope="row" align="left"| message
|
|
string
string
|-
! scope="row" align="left"| success
|
|}
|-
! scope="row" align="left"| _updated_category_versions
|
|}
|}
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,078: Line 1,237:
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|}
|}
====== Category-PATCH-404 ======
<hr>
==== <div id="Category-PUT">PUT</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Create and retrieve a 'special' category.'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
===== Status Codes =====
====== <div id="Category-PUT-201">201</div> ======
Description
Description
*  '''Category not found'''
*  '''Category created'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryNewResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| _links
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| self
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|-
! scope="row" align="left"| parent
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| category <small><em>(optional)</em></small>
|
|
integer
|}
====== Category-PATCH-412 ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| parent
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| etags
! scope="row" align="left"| links
|
|
array
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| condition
! scope="row" align="left"| items
|
|
string
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| href
| ''Current value of the entity tag for the requested variant.''
|
|}
====== Category-PATCH-400 ======
Description
*  '''Invalid request'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidCategoryRequest</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
string
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
<hr>
==== Category-PUT ====
Description
* '''Create and retrieve a 'special' category.'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
|}
===== Status Codes =====
====== Category-PUT-201 ======
Description
*  '''Category created'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryNewResponse</code>
|-
|-
! scope="row" align="left"| _links
|
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| self
Line 1,230: Line 1,358:
|}
|}
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| children
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,243: Line 1,371:
|}
|}
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,254: Line 1,382:
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| _base_uri
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| type_default
|
|
|}
integer
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| parent_id
|
|
{| class="lltable" border=1
uuid
|-
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| href
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| agent_id
|
|
|}
uuid
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| category_id
|
|
{| class="lltable" border=1
uuid
|-
|-
|-
! scope="row" align="left"| _created_categories
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _updated_category_versions
|
|
|}
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| Location
|
| ''The URL of the created category''
|}
====== <div id="Category-PUT-404">404</div> ======
Description
*  '''Category not found'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|-
|-
! scope="row" align="left"| children
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
|}
uuid
|-
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
integer
|}
====== <div id="Category-PUT-409">409</div> ======
Description
*  '''Category already exists'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryResponse</code>
|-
|-
! scope="row" align="left"| _links
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,332: Line 1,482:
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| parent
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| category <small><em>(optional)</em></small>
|
|
uuid
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| category_id
! scope="row" align="left"| parent
|
|
uuid
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| _created_categories
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|-
! scope="row" align="left"| links
|
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| href
| ''The URL of the created category''
|
|}
string
====== Category-PUT-404 ======
|-
Description
! scope="row" align="left"| name <small><em>(optional)</em></small>
*  '''Category not found'''
|
Response Schemas:
|}
|-
! scope="row" align="left"| items
|
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| self
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| children
|
|
integer
|}
====== Category-PUT-412 ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| etags
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
array
|}
|}
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| _base_uri
|
|
string
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| name
|
string
|-
! scope="row" align="left"| type_default
|
|
integer
integer
|-
|-
! scope="row" align="left"| condition
! scope="row" align="left"| parent_id
|
|
string
uuid
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| version
|
integer
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| agent_id
| ''Current value of the entity tag for the requested variant.''
|
uuid
|-
! scope="row" align="left"| category_id
|
uuid
|}
|}
====== Category-PUT-409 ======
====== <div id="Category-PUT-412">412</div> ======
Description
Description
*  '''Category already exists'''
*  '''Precondition failed'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
|}
string
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| etags
|
|
{| class="lltable" border=1
array
|-
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
|}
integer
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| condition
|
|
string
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
<hr>
==== <div id="Category-PATCH">PATCH</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Modify a category'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
===== Request Schemas =====
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">modifyCategory</code>
|-
|-
! scope="row" align="left"| name
|
|
string
string
|}
===== Status Codes =====
====== <div id="Category-PATCH-200">200</div> ======
Description
*  '''Category modified successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryModifyResponse</code>
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|-
! scope="row" align="left"| _links
|
|
|}
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,520: Line 1,716:
|}
|}
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| parent
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,533: Line 1,729:
|}
|}
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| category <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,546: Line 1,742:
|}
|}
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| parent
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,559: Line 1,755:
|}
|}
|-
|-
! scope="row" align="left"| children
! scope="row" align="left"| links
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,572: Line 1,768:
|}
|}
|-
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
! scope="row" align="left"| items
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,583: Line 1,779:
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| self
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| children
|
|
uuid
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| category_id
|
|
uuid
|}
|}
<hr>
==== Category-POST ====
Description
* '''Create inventory in category.'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
===== Request Schemas =====
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">newEmbeddedChildren</code>
|-
|-
! scope="row" align="left"| items <small><em>(optional)</em></small>
|
array
|-
! scope="row" align="left"| links <small><em>(optional)</em></small>
|
array
|-
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
array
|}
===== Status Codes =====
====== Category-POST-201 ======
Description
*  '''Inventory created'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryNewChildrenResponse</code>
|-
|-
! scope="row" align="left"| _links
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 1,670: Line 1,818:
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| _base_uri
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| type_default
|
integer
|-
! scope="row" align="left"| parent_id
|
|
|}
uuid
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| version
|
|
{| class="lltable" border=1
integer
|-
|-
! scope="row" align="left"| agent_id
|
uuid
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| category_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _updated_categories
|
|
|}
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
|
|
|}
integer
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| code
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| message
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| success
|
|
|}
|}
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| _updated_category_versions
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| ETag
|
| ''Current value of the entity tag for the requested variant.''
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|}
|-
====== <div id="Category-PATCH-400">400</div> ======
! scope="row" align="left"| self
Description
|
*  '''Invalid request'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidCategoryRequest</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|-
|-
! scope="row" align="left"| children
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
|}
uuid
|-
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
integer
|}
====== <div id="Category-PATCH-404">404</div> ======
Description
*  '''Category not found'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_description
|
|
|}
string
|}
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
string
uuid
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| error_code
|
|
integer
integer
|}
====== <div id="Category-PATCH-412">412</div> ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
! scope="row" align="left"| parent_id
|
uuid
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
uuid
string
|-
|-
! scope="row" align="left"| category_id
! scope="row" align="left"| error_description
|
|
uuid
string
|-
|-
! scope="row" align="left"| _embedded
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
string
|-
|-
! scope="row" align="left"| etags
|
array
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| etag
|
|
string
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| error_code
|
|
integer
|-
|-
! scope="row" align="left"| categories
! scope="row" align="left"| condition
|
|
string
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
<hr>
==== <div id="Category-COPY">COPY</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Copy a category'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| Destination
| ''Destination category_id or 'special' category.''
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
|}
===== Status Codes =====
====== <div id="Category-COPY-201">201</div> ======
Description
*  '''Category copied successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryCopyResponse</code>
|-
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| _links
Line 1,975: Line 2,181:
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| items
|
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| links
|
|-
! scope="row" align="left"| categories
|
|
|}
|}
|-
|-
! scope="row" align="left"| _created_categories
! scope="row" align="left"| _removed_items
|
|
|-
! scope="row" align="left"| _top_category_id
|
uuid
|-
|-
! scope="row" align="left"| _created_items
! scope="row" align="left"| _created_items
|
|-
! scope="row" align="left"| _moved_items
|
|-
! scope="row" align="left"| _created_categories
|
|
|-
|-
Line 1,992: Line 2,214:
|+Response Headers
|+Response Headers
|-
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| Location
| ''The URL of the category children containing the created inventory.''
| ''The URL of the copied inventory.''
|}
|}
====== Category-POST-404 ======
====== <div id="Category-COPY-403">403</div> ======
Description
Description
*  '''Category not found'''
*  '''Permissions check failed.'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
Line 2,019: Line 2,244:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 2,028: Line 2,249:
integer
integer
|}
|}
====== Category-POST-412 ======
====== <div id="Category-COPY-404">404</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Destination category not found.'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
Line 2,052: Line 2,273:
string
string
|-
|-
! scope="row" align="left"| etags
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
array
uuid
|-
! scope="row" align="left"| etag
|
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
|
|
integer
integer
|-
! scope="row" align="left"| condition
|
string
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
|}
====== Category-POST-409 ======
====== <div id="Category-COPY-409">409</div> ======
Description
Description
*  '''Duplicate transaction.'''
*  '''Duplicate transaction.'''
Line 2,107: Line 2,313:
string
string
|}
|}
====== Category-POST-400 ======
====== <div id="Category-COPY-410">410</div> ======
Description
Description
*  '''Invalid request'''
*  '''Source category gone'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidLinksShape</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
Line 2,131: Line 2,337:
string
string
|-
|-
! scope="row" align="left"| invalid_linked_ids <small><em>(optional)</em></small>
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 2,138: Line 2,345:
integer
integer
|}
|}
====== <div id="Category-COPY-412">412</div> ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidRequest</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
Line 2,155: Line 2,366:
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| etags
|
array
|-
! scope="row" align="left"| etag
|
|
string
string
Line 2,161: Line 2,380:
|
|
integer
integer
|-
! scope="row" align="left"| condition
|
string
|}
|}
<hr>
{| class="lltable" border=1
==== Category-COPY ====
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
<hr>
==== <div id="Category-MOVE">MOVE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Copy a category'''
* '''Move a category'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 2,174: Line 2,406:
|-
|-
! scope="row" align="left"| Destination
! scope="row" align="left"| Destination
| ''Destination category_id or 'special' category.''
| ''Destination category_id.''
|-
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
Line 2,180: Line 2,412:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== Category-COPY-201 ======
====== <div id="Category-MOVE-200">200</div> ======
Description
Description
*  '''Category copied successfully'''
*  '''Category moved successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryCopyResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryMoveResponse</code>
|-
|-
|-
|-
Line 2,339: Line 2,571:
uuid
uuid
|-
|-
! scope="row" align="left"| _embedded
! scope="row" align="left"| _updated_categories
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| items
|
|-
! scope="row" align="left"| links
|
|-
! scope="row" align="left"| categories
|
|}
|-
! scope="row" align="left"| _removed_items
|
|-
! scope="row" align="left"| _top_category_id
|
uuid
|-
! scope="row" align="left"| _created_items
|
|-
! scope="row" align="left"| _moved_items
|
|-
! scope="row" align="left"| _created_categories
|
|
|-
|-
Line 2,381: Line 2,585:
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| Location
| ''The URL of the copied inventory.''
| ''The URL of the moved inventory.''
|}
|}
====== Category-COPY-404 ======
====== <div id="Category-MOVE-403">403</div> ======
Description
Description
*  '''Destination category not found.'''
*  '''Permissions check failed.'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
Line 2,406: Line 2,610:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 2,415: Line 2,615:
integer
integer
|}
|}
====== Category-COPY-410 ======
====== <div id="Category-MOVE-404">404</div> ======
Description
Description
*  '''Source category gone'''
*  '''Destination category not found.'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
Line 2,447: Line 2,647:
integer
integer
|}
|}
====== Category-COPY-412 ======
====== <div id="Category-MOVE-410">410</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Source category gone'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
Line 2,471: Line 2,671:
string
string
|-
|-
! scope="row" align="left"| etags
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
array
uuid
|-
! scope="row" align="left"| etag
|
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
|
|
integer
integer
|-
! scope="row" align="left"| condition
|
string
|}
|}
{| class="lltable" border=1
====== <div id="Category-MOVE-412">412</div> ======
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
====== Category-COPY-403 ======
Description
Description
*  '''Permissions check failed.'''
*  '''Precondition failed'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
Line 2,518: Line 2,703:
string
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| etags
|
|
integer
array
|}
====== Category-COPY-409 ======
Description
*  '''Duplicate transaction.'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorDuplicateTransaction</code>
|-
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| error_code
|
|
string
integer
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| condition
|
|
string
string
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| error_code
|
integer
|-
|-
! scope="row" align="left"| transaction_id
! scope="row" align="left"| ETag
|
| ''Current value of the entity tag for the requested variant.''
string
|}
|}
<hr>
<hr>
==== Category-DELETE ====
==== <div id="Category-DELETE">DELETE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
Description
* '''Delete a category'''
* '''Delete a category'''
Line 2,569: Line 2,743:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== Category-DELETE-200 ======
====== <div id="Category-DELETE-200">200</div> ======
Description
Description
*  '''Category deleted successfully'''
*  '''Category deleted successfully'''
Line 2,627: Line 2,801:
|
|
|}
|}
====== Category-DELETE-410 ======
====== <div id="Category-DELETE-410">410</div> ======
Description
Description
*  '''Category gone'''
*  '''Category gone'''
Line 2,659: Line 2,833:
integer
integer
|}
|}
====== Category-DELETE-412 ======
====== <div id="Category-DELETE-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 2,723: Line 2,897:
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
<hr>
<hr>
==== CategoryChildren-PUT ====
==== <div id="CategoryChildren-GET">GET</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
Description
* '''Replace category children.'''
* '''Retrieve children in a category'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 2,736: Line 2,912:
| ''Only process request if any supplied entity tags matches resource.''
| ''Only process request if any supplied entity tags matches resource.''
|}
|}
===== Request Schemas =====
===== Status Codes =====
{| class="lltable" border=1
====== <div id="CategoryChildren-GET-200">200</div> ======
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">newEmbeddedChildren</code>
|-
|-
! scope="row" align="left"| items <small><em>(optional)</em></small>
|
array
|-
! scope="row" align="left"| links <small><em>(optional)</em></small>
|
array
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
array
|}
===== Status Codes =====
====== CategoryChildren-PUT-201 ======
Description
Description
*  '''Category children replaced'''
*  '''Category children retrieved successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryChildrenReplaceResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryChildrenResponse</code>
|-
|-
|-
|-
Line 2,927: Line 3,086:
|
|
|}
|}
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| _attachments_removed
|
|-
|-
! scope="row" align="left"| _active_gestures_removed
! scope="row" align="left"| ETag
|
| ''Current value of the entity tag for the requested variant.''
|-
! scope="row" align="left"| _broken_links_removed
|
|-
! scope="row" align="left"| _total_items_removed
|
integer
|-
! scope="row" align="left"| _created_items
|
|-
! scope="row" align="left"| _wearables_removed
|
|-
! scope="row" align="left"| _created_categories
|
|-
! scope="row" align="left"| _categories_removed
|
|-
! scope="row" align="left"| _updated_category_versions
|
|}
|}
====== <div id="CategoryChildren-GET-304">304</div> ======
Description
*  '''Not modified'''
Response Schemas:
string
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|+Response Headers
Line 2,962: Line 3,105:
! scope="row" align="left"| ETag
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|-
! scope="row" align="left"| Location
| ''The URL of the replaced category children.''
|}
|}
====== CategoryChildren-PUT-404 ======
====== <div id="CategoryChildren-GET-404">404</div> ======
Description
Description
*  '''Category not found'''
*  '''Category not found'''
Line 2,998: Line 3,138:
integer
integer
|}
|}
====== CategoryChildren-PUT-412 ======
====== <div id="CategoryChildren-GET-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 3,046: Line 3,186:
|}
|}
<hr>
<hr>
==== CategoryChildren-MOVE ====
==== <div id="CategoryChildren-PUT">PUT</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Move category children'''
* '''Replace category children.'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 3,056: Line 3,198:
| ''Only process request if none of the supplied entity tags matches resource.''
| ''Only process request if none of the supplied entity tags matches resource.''
|-
|-
! scope="row" align="left"| Destination
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Destination category_id.''
| ''Only process request if any supplied entity tags matches resource.''
|}
===== Request Schemas =====
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">newEmbeddedChildren</code>
|-
|-
! scope="row" align="left"| items <small><em>(optional)</em></small>
|
array
|-
! scope="row" align="left"| links <small><em>(optional)</em></small>
|
array
|-
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
! scope="row" align="left"| categories <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|
array
|}
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryChildren-MOVE-200 ======
====== <div id="CategoryChildren-PUT-201">201</div> ======
Description
Description
*  '''Category children moved successfully'''
*  '''Category children replaced'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryChildrenMoveResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryChildrenReplaceResponse</code>
|-
|-
|-
|-
Line 3,237: Line 3,393:
|}
|}
|-
|-
! scope="row" align="left"| _updated_items
! scope="row" align="left"| _attachments_removed
|
|-
! scope="row" align="left"| _active_gestures_removed
|
|-
! scope="row" align="left"| _broken_links_removed
|
|-
! scope="row" align="left"| _total_items_removed
|
integer
|-
! scope="row" align="left"| _created_items
|
|-
! scope="row" align="left"| _wearables_removed
|
|-
! scope="row" align="left"| _created_categories
|
|
|-
|-
! scope="row" align="left"| _updated_categories
! scope="row" align="left"| _categories_removed
|
|
|-
|-
Line 3,254: Line 3,429:
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| Location
| ''The URL of the moved inventory.''
| ''The URL of the replaced category children.''
|}
|}
====== CategoryChildren-MOVE-404 ======
====== <div id="CategoryChildren-PUT-404">404</div> ======
Description
Description
*  '''Destination category not found.'''
*  '''Category not found'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
Line 3,288: Line 3,463:
integer
integer
|}
|}
====== CategoryChildren-MOVE-403 ======
====== <div id="CategoryChildren-PUT-412">412</div> ======
Description
Description
*  '''Permissions check failed.'''
*  '''Precondition failed'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
Line 3,312: Line 3,487:
string
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| etags
|
|
integer
array
|}
|-
====== CategoryChildren-MOVE-412 ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| etags
|
array
|-
! scope="row" align="left"| etag
! scope="row" align="left"| etag
|
|
Line 3,362: Line 3,509:
! scope="row" align="left"| ETag
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|}
====== CategoryChildren-MOVE-410 ======
Description
*  '''Source category gone'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
|}
<hr>
<hr>
==== CategoryChildren-COPY ====
==== <div id="CategoryChildren-COPY">COPY</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Copy category children'''
* '''Copy category children'''
Line 3,413: Line 3,530:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryChildren-COPY-201 ======
====== <div id="CategoryChildren-COPY-201">201</div> ======
Description
Description
*  '''Category children copied successfully'''
*  '''Category children copied successfully'''
Line 3,616: Line 3,733:
| ''The URL of the copied inventory.''
| ''The URL of the copied inventory.''
|}
|}
====== CategoryChildren-COPY-410 ======
====== <div id="CategoryChildren-COPY-403">403</div> ======
Description
Description
*  '''Source category gone'''
*  '''Permissions check failed.'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
Line 3,639: Line 3,756:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 3,648: Line 3,761:
integer
integer
|}
|}
====== CategoryChildren-COPY-404 ======
====== <div id="CategoryChildren-COPY-404">404</div> ======
Description
Description
*  '''Destination category not found.'''
*  '''Destination category not found.'''
Line 3,680: Line 3,793:
integer
integer
|}
|}
====== CategoryChildren-COPY-403 ======
====== <div id="CategoryChildren-COPY-410">410</div> ======
Description
Description
*  '''Permissions check failed.'''
*  '''Source category gone'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
Line 3,703: Line 3,816:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 3,708: Line 3,825:
integer
integer
|}
|}
====== CategoryChildren-COPY-412 ======
====== <div id="CategoryChildren-COPY-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 3,756: Line 3,873:
|}
|}
<hr>
<hr>
==== CategoryChildren-DELETE ====
==== <div id="CategoryChildren-MOVE">MOVE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Delete category children'''
* '''Move category children'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 3,765: Line 3,884:
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| Destination
| ''Destination category_id.''
|-
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
Line 3,770: Line 3,892:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryChildren-DELETE-200 ======
====== <div id="CategoryChildren-MOVE-200">200</div> ======
Description
Description
*  '''Category children deleted successfully'''
*  '''Category children moved successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryDeleteResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryChildrenMoveResponse</code>
|-
|-
! scope="row" align="left"| _links
|
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| code
! scope="row" align="left"| parent
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| message
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| success
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|-
|-
! scope="row" align="left"| _attachments_removed
! scope="row" align="left"| category <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| _active_gestures_removed
|-
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| _broken_links_removed
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| _total_items_removed
! scope="row" align="left"| parent
|
|
integer
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| _wearables_removed
|
|-
|-
! scope="row" align="left"| _category_items_removed
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| _categories_removed
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| links
|
|
|}
====== CategoryChildren-DELETE-410 ======
Description
*  '''Category gone'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| items
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| self
|
|
integer
|}
====== CategoryChildren-DELETE-412 ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| children
|
|
string
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| etags
|
array
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| condition
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
|
string
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| href
| ''Current value of the entity tag for the requested variant.''
|
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|}
<hr>
==== CategoryChildren-GET ====
Description
* '''Retrieve children in a category'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
|}
===== Status Codes =====
====== CategoryChildren-GET-200 ======
Description
*  '''Category children retrieved successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryChildrenResponse</code>
|-
|-
! scope="row" align="left"| _base_uri
|
string
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| name
|
|
{| class="lltable" border=1
string
|-
|-
! scope="row" align="left"| type_default
|
integer
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| parent_id
|
|
{| class="lltable" border=1
uuid
|-
|-
! scope="row" align="left"| version
|
integer
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| agent_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id
|
|
|}
uuid
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| _embedded
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| items
|
|
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| links
|
|
|}
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| categories
|
|
{| class="lltable" border=1
|}
|-
|-
! scope="row" align="left"| _updated_items
|
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| _updated_categories
|
|
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _updated_category_versions
|
|
|}
|}
|-
! scope="row" align="left"| parent
|
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| ETag
|
| ''Current value of the entity tag for the requested variant.''
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| Location
|
| ''The URL of the moved inventory.''
|}
|}
|-
====== <div id="CategoryChildren-MOVE-403">403</div> ======
! scope="row" align="left"| links
Description
|
*  '''Permissions check failed.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
integer
|}
|}
====== <div id="CategoryChildren-MOVE-404">404</div> ======
Description
*  '''Destination category not found.'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
! scope="row" align="left"| self
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_description
|
|
|}
string
|-
|-
! scope="row" align="left"| children
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
integer
|}
|}
|-
====== <div id="CategoryChildren-MOVE-410">410</div> ======
! scope="row" align="left"| categories <small><em>(optional)</em></small>
Description
|
*  '''Source category gone'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|}
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| error_description
|
|
string
string
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| parent_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| error_code
|
|
integer
integer
|}
====== <div id="CategoryChildren-MOVE-412">412</div> ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
uuid
integer
|-
|-
! scope="row" align="left"| category_id
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
uuid
string
|-
|-
! scope="row" align="left"| _embedded
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
|-
! scope="row" align="left"| etags
|
array
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| etag
|
|
string
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| error_code
|
|
integer
|-
|-
! scope="row" align="left"| categories
! scope="row" align="left"| condition
|
|
|}
string
|}
|}
{| class="lltable" border=1
{| class="lltable" border=1
Line 4,103: Line 4,224:
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|}
|}
====== CategoryChildren-GET-404 ======
<hr>
==== <div id="CategoryChildren-DELETE">DELETE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Delete category children'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
===== Status Codes =====
====== <div id="CategoryChildren-DELETE-200">200</div> ======
Description
Description
*  '''Category not found'''
*  '''Category children deleted successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryDeleteResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| code
|
|
string
integer
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| message
|
|
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| success
|
|
uuid
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| _attachments_removed
|
|
integer
|-
|}
! scope="row" align="left"| _active_gestures_removed
====== CategoryChildren-GET-304 ======
|
Description
|-
*  '''Not modified'''
! scope="row" align="left"| _broken_links_removed
|
|-
! scope="row" align="left"| _total_items_removed
|
integer
|-
! scope="row" align="left"| _wearables_removed
|
|-
! scope="row" align="left"| _category_items_removed
|
|-
! scope="row" align="left"| _categories_removed
|
|-
! scope="row" align="left"| _updated_category_versions
|
|}
====== <div id="CategoryChildren-DELETE-410">410</div> ======
Description
*  '''Category gone'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
string
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
| ''Current value of the entity tag for the requested variant.''
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
|}
====== CategoryChildren-GET-412 ======
====== <div id="CategoryChildren-DELETE-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 4,209: Line 4,393:
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
<hr>
<hr>
==== CategoryLinks-PUT ====
==== <div id="CategoryLinks-GET">GET</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
Description
* '''Replace category links.'''
* '''Retrieve links in a category'''
===== Request Schemas =====
array
===== Status Codes =====
===== Status Codes =====
====== CategoryLinks-PUT-201 ======
====== <div id="CategoryLinks-GET-200">200</div> ======
Description
Description
*  '''Category links replaced'''
*  '''Category links retrieved successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryLinksReplaceResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryLinksResponse</code>
|-
|-
|-
|-
Line 4,382: Line 4,566:
|
|
|}
|}
|-
! scope="row" align="left"| _linked_ids
|
|-
! scope="row" align="left"| _updated_items
|
|-
! scope="row" align="left"| _category_items_removed
|
|-
! scope="row" align="left"| _created_items
|
|-
! scope="row" align="left"| _updated_category_versions
|
|}
|}
{| class="lltable" border=1
====== <div id="CategoryLinks-GET-404">404</div> ======
|+Response Headers
|-
|-
! scope="row" align="left"| Location
| ''The URL of the replaced category links.''
|}
====== CategoryLinks-PUT-404 ======
Description
Description
*  '''Category not found'''
*  '''Category not found'''
Line 4,437: Line 4,599:
integer
integer
|}
|}
====== CategoryLinks-PUT-400 ======
<hr>
==== <div id="CategoryLinks-PUT">PUT</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
Description
*  '''Invalid request'''
* '''Replace category links.'''
===== Request Schemas =====
array
===== Status Codes =====
====== <div id="CategoryLinks-PUT-201">201</div> ======
Description
*  '''Category links replaced'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidLinksShape</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryLinksReplaceResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| _links
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| self
|
|
string
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| error_description
|
string
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| invalid_linked_ids <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| parent
|
|
integer
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidRequest</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_code
|
integer
|}
<hr>
==== CategoryLinks-MOVE ====
Description
* '''Move category links'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| Destination
| ''Destination category_id.''
|}
===== Status Codes =====
====== CategoryLinks-MOVE-200 ======
Description
*  '''Category links moved successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryLinksMoveResponse</code>
|-
|-
! scope="row" align="left"| _links
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| self
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| href
|
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|-
! scope="row" align="left"| parent
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| href
|
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| category <small><em>(optional)</em></small>
Line 4,671: Line 4,775:
|
|
|}
|}
|-
! scope="row" align="left"| _linked_ids
|
|-
|-
! scope="row" align="left"| _updated_items
! scope="row" align="left"| _updated_items
|
|-
! scope="row" align="left"| _category_items_removed
|
|-
! scope="row" align="left"| _created_items
|
|
|-
|-
Line 4,683: Line 4,796:
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| Location
| ''The URL of the moved inventory.''
| ''The URL of the replaced category links.''
|}
|}
====== CategoryLinks-MOVE-404 ======
====== <div id="CategoryLinks-PUT-400">400</div> ======
Description
Description
*  '''Destination category not found.'''
*  '''Invalid request'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidLinksShape</code>
|-
|-
|-
|-
Line 4,709: Line 4,822:
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| invalid_linked_ids <small><em>(optional)</em></small>
|
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 4,717: Line 4,829:
integer
integer
|}
|}
====== CategoryLinks-MOVE-403 ======
Description
*  '''Permissions check failed.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidRequest</code>
|-
|-
|-
|-
Line 4,745: Line 4,853:
integer
integer
|}
|}
====== CategoryLinks-MOVE-410 ======
====== <div id="CategoryLinks-PUT-404">404</div> ======
Description
Description
*  '''Source category gone'''
*  '''Category not found'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
Line 4,778: Line 4,886:
|}
|}
<hr>
<hr>
==== CategoryLinks-COPY ====
==== <div id="CategoryLinks-COPY">COPY</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Copy category links'''
* '''Copy category links'''
Line 4,789: Line 4,899:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryLinks-COPY-201 ======
====== <div id="CategoryLinks-COPY-201">201</div> ======
Description
Description
*  '''Category links copied successfully'''
*  '''Category links copied successfully'''
Line 4,970: Line 5,080:
| ''The URL of the copied inventory.''
| ''The URL of the copied inventory.''
|}
|}
====== CategoryLinks-COPY-410 ======
====== <div id="CategoryLinks-COPY-403">403</div> ======
Description
Description
*  '''Source category gone'''
*  '''Permissions check failed.'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
Line 4,993: Line 5,103:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 5,002: Line 5,108:
integer
integer
|}
|}
====== CategoryLinks-COPY-404 ======
====== <div id="CategoryLinks-COPY-404">404</div> ======
Description
Description
*  '''Destination category not found.'''
*  '''Destination category not found.'''
Line 5,034: Line 5,140:
integer
integer
|}
|}
====== CategoryLinks-COPY-403 ======
====== <div id="CategoryLinks-COPY-410">410</div> ======
Description
Description
*  '''Permissions check failed.'''
*  '''Source category gone'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
Line 5,057: Line 5,163:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 5,063: Line 5,173:
|}
|}
<hr>
<hr>
==== CategoryLinks-DELETE ====
==== <div id="CategoryLinks-MOVE">MOVE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Delete category links'''
* '''Move category links'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| Destination
| ''Destination category_id.''
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryLinks-DELETE-200 ======
====== <div id="CategoryLinks-MOVE-200">200</div> ======
Description
Description
*  '''Category links deleted successfully'''
*  '''Category links moved successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryLinksDeleteResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryLinksMoveResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| _category_items_removed
! scope="row" align="left"| _links
|
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| _updated_category_versions
|-
|
! scope="row" align="left"| self
|}
====== CategoryLinks-DELETE-410 ======
Description
*  '''Category gone'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
<hr>
==== CategoryLinks-GET ====
Description
* '''Retrieve links in a category'''
===== Status Codes =====
====== CategoryLinks-GET-200 ======
Description
*  '''Category links retrieved successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryLinksResponse</code>
|-
|-
! scope="row" align="left"| _links
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,285: Line 5,353:
|
|
|}
|}
|-
! scope="row" align="left"| _updated_items
|
|-
! scope="row" align="left"| _updated_category_versions
|
|}
|}
====== CategoryLinks-GET-404 ======
Description
*  '''Category not found'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| Location
|
| ''The URL of the moved inventory.''
|}
====== <div id="CategoryLinks-MOVE-403">403</div> ======
Description
*  '''Permissions check failed.'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
integer
|-
|-
Line 5,309: Line 5,390:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 5,318: Line 5,395:
integer
integer
|}
|}
<hr>
====== <div id="CategoryLinks-MOVE-404">404</div> ======
=== CategoryItems ===
Description
Description
* '''Items in an inventory category.'''
*  '''Destination category not found.'''
Path:
Response Schemas:
* ''/category/''<code style="border: 1px solid #E1E1E8; color: #DD1144; background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{category}</code>''/items''<code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{?tid,simulate}</code>
==== Parameters ====
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">category</code> &rarr; Category UUID or 'special' category name, e.g. "current".
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$</code>
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">tid</code> &rarr; Transaction ID.
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">simulate</code> &rarr; Whether or not to skip writing back results.
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
<hr>
==== CategoryItems-PUT ====
Description
* '''Replace category items.'''
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|
integer
|-
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|
|}
string
===== Request Schemas =====
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">replaceCategoryItems</code>
|-
|-
! scope="row" align="left"| error_description
|
string
|-
|-
! scope="row" align="left"| items <small><em>(optional)</em></small>
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
array
string
|-
|-
! scope="row" align="left"| links <small><em>(optional)</em></small>
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
array
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
|}
===== Status Codes =====
====== <div id="CategoryLinks-MOVE-410">410</div> ======
====== CategoryItems-PUT-201 ======
Description
Description
*  '''Category items replaced'''
*  '''Source category gone'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryItemsReplaceResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
|}
uuid
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| error_code
|
|
integer
|}
<hr>
==== <div id="CategoryLinks-DELETE">DELETE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Delete category links'''
===== Status Codes =====
====== <div id="CategoryLinks-DELETE-200">200</div> ======
Description
*  '''Category links deleted successfully'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryLinksDeleteResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| _category_items_removed
|
|
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _updated_category_versions
|
|
|}
|}
====== <div id="CategoryLinks-DELETE-410">410</div> ======
Description
*  '''Category gone'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_description
|
|
|}
string
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
<hr>
=== CategoryItems ===
Description
* '''Items in an inventory category.'''
Path:
* ''/category/''<code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{category}</code>''/items''<code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{?tid,simulate}</code>
==== Parameters ====
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">category</code> &rarr; Category UUID or 'special' category name, e.g. "current".
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$</code>
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">tid</code> &rarr; Transaction ID.
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">simulate</code> &rarr; Whether or not to skip writing back results.
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
<hr>
==== <div id="CategoryItems-GET">GET</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Retrieve items in a category'''
===== Status Codes =====
====== <div id="CategoryItems-GET-200">200</div> ======
Description
*  '''Category items retrieved successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryItemsResponse</code>
|-
|-
! scope="row" align="left"| _links
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,425: Line 5,559:
|}
|}
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| parent
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,438: Line 5,572:
|}
|}
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| category <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,451: Line 5,585:
|}
|}
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| parent
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,464: Line 5,598:
|}
|}
|-
|-
! scope="row" align="left"| children
! scope="row" align="left"| links
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,477: Line 5,611:
|}
|}
|-
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
! scope="row" align="left"| items
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,488: Line 5,622:
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| self
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| children
|
|
uuid
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| version
|
integer
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| href
|
|
uuid
string
|-
|-
! scope="row" align="left"| category_id
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| _embedded
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|-
|-
! scope="row" align="left"| _attachments_removed
! scope="row" align="left"| _base_uri
|
string
|-
! scope="row" align="left"| name
|
|
string
|-
|-
! scope="row" align="left"| _linked_ids
! scope="row" align="left"| type_default
|
|
integer
|-
|-
! scope="row" align="left"| _active_gestures_removed
! scope="row" align="left"| parent_id
|
|
uuid
|-
|-
! scope="row" align="left"| _broken_links_removed
! scope="row" align="left"| version
|
|
integer
|-
|-
! scope="row" align="left"| _created_items
! scope="row" align="left"| agent_id
|
|
uuid
|-
|-
! scope="row" align="left"| _wearables_removed
! scope="row" align="left"| category_id
|
|
uuid
|-
|-
! scope="row" align="left"| _updated_items
! scope="row" align="left"| _embedded
|
|
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| _category_items_removed
! scope="row" align="left"| items
|
|
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| links
|
|
|}
|}
|}
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,564: Line 5,710:
! scope="row" align="left"| ETag
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|-
! scope="row" align="left"| Location
| ''The URL of the replaced category items.''
|}
|}
====== CategoryItems-PUT-404 ======
====== <div id="CategoryItems-GET-304">304</div> ======
Description
Description
*  '''Category not found'''
*  '''Not modified'''
Response Schemas:
string
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
====== <div id="CategoryItems-GET-404">404</div> ======
Description
*  '''Category not found'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,600: Line 5,755:
integer
integer
|}
|}
====== CategoryItems-PUT-412 ======
====== <div id="CategoryItems-GET-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 5,648: Line 5,803:
|}
|}
<hr>
<hr>
==== CategoryItems-MOVE ====
==== <div id="CategoryItems-PUT">PUT</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Move category items'''
* '''Replace category items.'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,657: Line 5,814:
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| Destination
| ''Destination category_id.''
|-
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
| ''Only process request if any supplied entity tags matches resource.''
|}
===== Request Schemas =====
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">replaceCategoryItems</code>
|-
|-
! scope="row" align="left"| items <small><em>(optional)</em></small>
|
array
|-
! scope="row" align="left"| links <small><em>(optional)</em></small>
|
array
|}
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryItems-MOVE-200 ======
====== <div id="CategoryItems-PUT-201">201</div> ======
Description
Description
*  '''Category items moved successfully'''
*  '''Category items replaced'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryItemsMoveResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryItemsReplaceResponse</code>
|-
|-
|-
|-
Line 5,835: Line 6,002:
|
|
|}
|}
|-
! scope="row" align="left"| _attachments_removed
|
|-
! scope="row" align="left"| _linked_ids
|
|-
! scope="row" align="left"| _active_gestures_removed
|
|-
! scope="row" align="left"| _broken_links_removed
|
|-
! scope="row" align="left"| _created_items
|
|-
! scope="row" align="left"| _wearables_removed
|
|-
|-
! scope="row" align="left"| _updated_items
! scope="row" align="left"| _updated_items
|
|-
! scope="row" align="left"| _category_items_removed
|
|
|-
|-
Line 5,850: Line 6,038:
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| Location
| ''The URL of the moved inventory.''
| ''The URL of the replaced category items.''
|}
|}
====== CategoryItems-MOVE-404 ======
====== <div id="CategoryItems-PUT-404">404</div> ======
Description
Description
*  '''Destination category not found.'''
*  '''Category not found'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
Line 5,884: Line 6,072:
integer
integer
|}
|}
====== CategoryItems-MOVE-403 ======
====== <div id="CategoryItems-PUT-412">412</div> ======
Description
Description
*  '''Permissions check failed.'''
*  '''Precondition failed'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
Line 5,908: Line 6,096:
string
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| etags
|
integer
|}
====== CategoryItems-MOVE-412 ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| etags
|
|
array
array
Line 5,958: Line 6,118:
! scope="row" align="left"| ETag
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|}
====== CategoryItems-MOVE-410 ======
Description
*  '''Source category gone'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
|}
<hr>
<hr>
==== CategoryItems-COPY ====
==== <div id="CategoryItems-COPY">COPY</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Copy category items'''
* '''Copy category items'''
Line 6,009: Line 6,139:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryItems-COPY-201 ======
====== <div id="CategoryItems-COPY-201">201</div> ======
Description
Description
*  '''Category items copied successfully'''
*  '''Category items copied successfully'''
Line 6,196: Line 6,326:
| ''The URL of the copied inventory.''
| ''The URL of the copied inventory.''
|}
|}
====== CategoryItems-COPY-410 ======
====== <div id="CategoryItems-COPY-403">403</div> ======
Description
Description
*  '''Source category gone'''
*  '''Permissions check failed.'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
Line 6,219: Line 6,349:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 6,228: Line 6,354:
integer
integer
|}
|}
====== CategoryItems-COPY-404 ======
====== <div id="CategoryItems-COPY-404">404</div> ======
Description
Description
*  '''Destination category not found.'''
*  '''Destination category not found.'''
Line 6,260: Line 6,386:
integer
integer
|}
|}
====== CategoryItems-COPY-403 ======
====== <div id="CategoryItems-COPY-410">410</div> ======
Description
Description
*  '''Permissions check failed.'''
*  '''Source category gone'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
Line 6,283: Line 6,409:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 6,288: Line 6,418:
integer
integer
|}
|}
====== CategoryItems-COPY-412 ======
====== <div id="CategoryItems-COPY-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 6,336: Line 6,466:
|}
|}
<hr>
<hr>
==== CategoryItems-DELETE ====
==== <div id="CategoryItems-MOVE">MOVE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Delete category items'''
* '''Move category items'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,345: Line 6,477:
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| Destination
| ''Destination category_id.''
|-
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
Line 6,350: Line 6,485:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryItems-DELETE-200 ======
====== <div id="CategoryItems-MOVE-200">200</div> ======
Description
Description
*  '''Category items deleted successfully'''
*  '''Category items moved successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryItemsDeleteResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryItemsMoveResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| _attachments_removed
! scope="row" align="left"| _links
|
|
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| _active_gestures_removed
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| _broken_links_removed
|
|-
|-
! scope="row" align="left"| _wearables_removed
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| _category_items_removed
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| parent
|
|
|}
====== CategoryItems-DELETE-410 ======
Description
*  '''Category gone'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| category <small><em>(optional)</em></small>
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| parent
|
|
integer
|}
====== CategoryItems-DELETE-412 ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| links
|
|
string
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| etags
|
array
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| condition
! scope="row" align="left"| items
|
|
string
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| href
| ''Current value of the entity tag for the requested variant.''
|
|}
string
<hr>
==== CategoryItems-GET ====
Description
* '''Retrieve items in a category'''
===== Status Codes =====
====== CategoryItems-GET-200 ======
Description
*  '''Category items retrieved successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryItemsResponse</code>
|-
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _links
|
|
{| class="lltable" border=1
|}
|-
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| self
Line 6,486: Line 6,589:
|}
|}
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| children
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,499: Line 6,602:
|}
|}
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,510: Line 6,613:
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| _base_uri
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| type_default
|
|
|}
integer
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| parent_id
|
|
{| class="lltable" border=1
uuid
|-
|-
! scope="row" align="left"| version
|
integer
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| agent_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id
|
|
|}
uuid
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| _embedded
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| items
|
|
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| links
|
|
|}
|}
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| _updated_items
|
|-
! scope="row" align="left"| _updated_category_versions
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| ETag
|
| ''Current value of the entity tag for the requested variant.''
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| Location
|
| ''The URL of the moved inventory.''
|}
|}
|-
====== <div id="CategoryItems-MOVE-403">403</div> ======
! scope="row" align="left"| children
Description
|
*  '''Permissions check failed.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|}
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_description
|
|}
|}
|-
! scope="row" align="left"| _base_uri
|
|
string
string
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| error_code
|
|
integer
integer
|-
! scope="row" align="left"| parent_id
|
uuid
|-
! scope="row" align="left"| version
|
integer
|-
! scope="row" align="left"| agent_id
|
uuid
|-
! scope="row" align="left"| category_id
|
uuid
|-
! scope="row" align="left"| _embedded
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| items
|
|-
! scope="row" align="left"| links
|
|}
|}
|}
{| class="lltable" border=1
====== <div id="CategoryItems-MOVE-404">404</div> ======
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
====== CategoryItems-GET-404 ======
Description
Description
*  '''Category not found'''
*  '''Destination category not found.'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,670: Line 6,732:
integer
integer
|}
|}
====== CategoryItems-GET-304 ======
====== <div id="CategoryItems-MOVE-410">410</div> ======
Description
Description
*  '''Not modified'''
*  '''Source category gone'''
Response Schemas:
Response Schemas:
string
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| error_code
| ''Current value of the entity tag for the requested variant.''
|
integer
|}
|}
====== CategoryItems-GET-412 ======
====== <div id="CategoryItems-MOVE-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 6,730: Line 6,812:
|}
|}
<hr>
<hr>
=== CategoryCategories ===
==== <div id="CategoryItems-DELETE">DELETE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
Description
* '''Categories in an inventory category.'''
* '''Delete category items'''
Path:
* ''/category/''<code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{category}</code>''/categories''<code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{?tid,depth,simulate}</code>
==== Parameters ====
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">category</code> &rarr; Category UUID or 'special' category name, e.g. "current".
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$</code>
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">tid</code> &rarr; Transaction ID.
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">depth</code> &rarr; Category child depth to retrieve.
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(\*|[0-9]+)?$</code>
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">simulate</code> &rarr; Whether or not to skip writing back results.
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
<hr>
==== CategoryCategories-PUT ====
Description
* '''Replace category categories.'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,759: Line 6,827:
| ''Only process request if any supplied entity tags matches resource.''
| ''Only process request if any supplied entity tags matches resource.''
|}
|}
===== Request Schemas =====
array
===== Status Codes =====
===== Status Codes =====
====== CategoryCategories-PUT-201 ======
====== <div id="CategoryItems-DELETE-200">200</div> ======
Description
Description
*  '''Category categories replaced'''
*  '''Category items deleted successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryChildrenReplaceResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryItemsDeleteResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| _attachments_removed
|
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| _active_gestures_removed
|
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| _broken_links_removed
|
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| _wearables_removed
|
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| _category_items_removed
|
|
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _updated_category_versions
|
|
|}
|}
|-
====== <div id="CategoryItems-DELETE-410">410</div> ======
! scope="row" align="left"| parent
Description
|
*  '''Category gone'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
|}
uuid
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| error_code
|
|
integer
|}
====== <div id="CategoryItems-DELETE-412">412</div> ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_description
|
|
|}
string
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
string
|-
|-
! scope="row" align="left"| etags
|
array
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| etag
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
|}
integer
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| condition
|
string
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
<hr>
=== CategoryCategories ===
Description
* '''Categories in an inventory category.'''
Path:
* ''/category/''<code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{category}</code>''/categories''<code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{?tid,depth,simulate}</code>
==== Parameters ====
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">category</code> &rarr; Category UUID or 'special' category name, e.g. "current".
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(animatn|bodypart|clothing|current|favorite|gesture|inbox|landmark|lsltext)$</code>
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(lstndfnd|my_otfts|notecard|object|outbox|root|snapshot|sound|texture|trash)$</code>
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">tid</code> &rarr; Transaction ID.
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">depth</code> &rarr; Category child depth to retrieve.
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(\*|[0-9]+)?$</code>
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">simulate</code> &rarr; Whether or not to skip writing back results.
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
<hr>
==== <div id="CategoryCategories-GET">GET</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Retrieve categories in a category'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
===== Status Codes =====
====== <div id="CategoryCategories-GET-200">200</div> ======
Description
*  '''Category categories retrieved successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryCategoriesResponse</code>
|-
|-
! scope="row" align="left"| _links
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,853: Line 6,992:
|}
|}
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| parent
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,866: Line 7,005:
|}
|}
|-
|-
! scope="row" align="left"| children
! scope="row" align="left"| category <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,879: Line 7,018:
|}
|}
|-
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
! scope="row" align="left"| parent
|
|
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,890: Line 7,029:
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| links
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| items
|
|
uuid
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| version
|
integer
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| href
|
|
uuid
string
|-
|-
! scope="row" align="left"| category_id
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| _embedded
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| items
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| categories
! scope="row" align="left"| children
|
|
|}
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| _attachments_removed
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| _active_gestures_removed
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| _broken_links_removed
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| _total_items_removed
|
integer
|-
|-
! scope="row" align="left"| _created_items
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| _wearables_removed
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|-
|-
! scope="row" align="left"| _created_categories
! scope="row" align="left"| _base_uri
|
|
string
|-
|-
! scope="row" align="left"| _categories_removed
! scope="row" align="left"| name
|
|
string
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| type_default
|
integer
|-
! scope="row" align="left"| parent_id
|
uuid
|-
! scope="row" align="left"| version
|
integer
|-
! scope="row" align="left"| agent_id
|
uuid
|-
! scope="row" align="left"| category_id
|
uuid
|-
! scope="row" align="left"| _embedded
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| categories
|
|
|}
|}
|}
{| class="lltable" border=1
{| class="lltable" border=1
Line 6,970: Line 7,140:
! scope="row" align="left"| ETag
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|}
====== <div id="CategoryCategories-GET-304">304</div> ======
Description
*  '''Not modified'''
Response Schemas:
string
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| ETag
| ''The URL of the replaced category categories.''
| ''Current value of the entity tag for the requested variant.''
|}
|}
====== CategoryCategories-PUT-404 ======
====== <div id="CategoryCategories-GET-404">404</div> ======
Description
Description
*  '''Category not found'''
*  '''Category not found'''
Line 7,006: Line 7,185:
integer
integer
|}
|}
====== CategoryCategories-PUT-412 ======
====== <div id="CategoryCategories-GET-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 7,054: Line 7,233:
|}
|}
<hr>
<hr>
==== CategoryCategories-MOVE ====
==== <div id="CategoryCategories-PUT">PUT</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Move category categories'''
* '''Replace category categories.'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 7,063: Line 7,244:
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| Destination
| ''Destination category_id.''
|-
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
| ''Only process request if any supplied entity tags matches resource.''
|}
|}
===== Request Schemas =====
array
===== Status Codes =====
===== Status Codes =====
====== CategoryCategories-MOVE-200 ======
====== <div id="CategoryCategories-PUT-201">201</div> ======
Description
Description
*  '''Category categories moved successfully'''
*  '''Category categories replaced'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryCategoriesMoveResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryChildrenReplaceResponse</code>
|-
|-
|-
|-
Line 7,235: Line 7,415:
|-
|-
|-
|-
! scope="row" align="left"| categories
! scope="row" align="left"| items
|
|
|}
|-
|-
! scope="row" align="left"| _updated_categories
! scope="row" align="left"| links
|
|
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| categories
|
|
|}
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| _attachments_removed
|
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| _active_gestures_removed
| ''Current value of the entity tag for the requested variant.''
|
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| _broken_links_removed
| ''The URL of the moved inventory.''
|
|}
====== CategoryCategories-MOVE-404 ======
Description
*  '''Destination category not found.'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
! scope="row" align="left"| _total_items_removed
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| _created_items
|
|
string
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| _wearables_removed
|
|
string
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| _created_categories
|
|
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| _categories_removed
|
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| _updated_category_versions
|
|
integer
|}
|}
====== CategoryCategories-MOVE-403 ======
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|-
! scope="row" align="left"| Location
| ''The URL of the replaced category categories.''
|}
====== <div id="CategoryCategories-PUT-404">404</div> ======
Description
Description
*  '''Permissions check failed.'''
*  '''Category not found'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
Line 7,310: Line 7,486:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 7,315: Line 7,495:
integer
integer
|}
|}
====== CategoryCategories-MOVE-412 ======
====== <div id="CategoryCategories-PUT-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 7,362: Line 7,542:
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|}
|}
====== CategoryCategories-MOVE-410 ======
<hr>
==== <div id="CategoryCategories-COPY">COPY</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Source category gone'''
* '''Copy category categories'''
Response Schemas:
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
|
| ''Only process request if none of the supplied entity tags matches resource.''
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| Destination
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
<hr>
==== CategoryCategories-COPY ====
Description
* '''Copy category categories'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| Destination
| ''Destination category_id or 'special' category.''
| ''Destination category_id or 'special' category.''
|-
|-
Line 7,412: Line 7,562:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryCategories-COPY-201 ======
====== <div id="CategoryCategories-COPY-201">201</div> ======
Description
Description
*  '''Category categories copied successfully'''
*  '''Category categories copied successfully'''
Line 7,615: Line 7,765:
| ''The URL of the copied inventory.''
| ''The URL of the copied inventory.''
|}
|}
====== CategoryCategories-COPY-410 ======
====== <div id="CategoryCategories-COPY-403">403</div> ======
Description
Description
*  '''Source category gone'''
*  '''Permissions check failed.'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
Line 7,638: Line 7,788:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 7,647: Line 7,793:
integer
integer
|}
|}
====== CategoryCategories-COPY-404 ======
====== <div id="CategoryCategories-COPY-404">404</div> ======
Description
Description
*  '''Destination category not found.'''
*  '''Destination category not found.'''
Line 7,679: Line 7,825:
integer
integer
|}
|}
====== CategoryCategories-COPY-403 ======
====== <div id="CategoryCategories-COPY-410">410</div> ======
Description
Description
*  '''Permissions check failed.'''
*  '''Source category gone'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
Line 7,702: Line 7,848:
|
|
string
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 7,707: Line 7,857:
integer
integer
|}
|}
====== CategoryCategories-COPY-412 ======
====== <div id="CategoryCategories-COPY-412">412</div> ======
Description
Description
*  '''Precondition failed'''
*  '''Precondition failed'''
Line 7,755: Line 7,905:
|}
|}
<hr>
<hr>
==== CategoryCategories-DELETE ====
==== <div id="CategoryCategories-MOVE">MOVE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Delete category categories'''
* '''Move category categories'''
===== Request Headers =====
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
Line 7,764: Line 7,916:
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
| ''Only process request if none of the supplied entity tags matches resource.''
| ''Only process request if none of the supplied entity tags matches resource.''
|-
! scope="row" align="left"| Destination
| ''Destination category_id.''
|-
|-
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
Line 7,769: Line 7,924:
|}
|}
===== Status Codes =====
===== Status Codes =====
====== CategoryCategories-DELETE-200 ======
====== <div id="CategoryCategories-MOVE-200">200</div> ======
Description
Description
*  '''Category categories deleted successfully'''
*  '''Category categories moved successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryDeleteResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryCategoriesMoveResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
! scope="row" align="left"| _links
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
! scope="row" align="left"| self
|
|
string
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
|
integer
|-
|-
! scope="row" align="left"| code
! scope="row" align="left"| href
|
integer
|-
! scope="row" align="left"| message
|
|
string
string
|-
|-
! scope="row" align="left"| success
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|-
|-
! scope="row" align="left"| _attachments_removed
! scope="row" align="left"| parent
|
|
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| _active_gestures_removed
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| _broken_links_removed
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| _total_items_removed
! scope="row" align="left"| category <small><em>(optional)</em></small>
|
|
integer
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| _wearables_removed
|
|-
|-
! scope="row" align="left"| _category_items_removed
! scope="row" align="left"| href
|
|
string
|-
|-
! scope="row" align="left"| _categories_removed
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| parent
|
|
|}
====== CategoryCategories-DELETE-410 ======
Description
*  '''Category gone'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| links
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| items
|
|
integer
{| class="lltable" border=1
|}
|-
====== CategoryCategories-DELETE-412 ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
! scope="row" align="left"| href
|
string
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| self
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| etags
! scope="row" align="left"| children
|
|
array
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| condition
! scope="row" align="left"| categories <small><em>(optional)</em></small>
|
|
string
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| href
| ''Current value of the entity tag for the requested variant.''
|
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|}
|}
<hr>
==== CategoryCategories-GET ====
Description
* '''Retrieve categories in a category'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| _base_uri
|
string
|-
|-
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
! scope="row" align="left"| name
| ''Only process request if none of the supplied entity tags matches resource.''
|
|-
string
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
| ''Only process request if any supplied entity tags matches resource.''
|}
===== Status Codes =====
====== CategoryCategories-GET-200 ======
Description
*  '''Category categories retrieved successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryCategoriesResponse</code>
|-
|-
! scope="row" align="left"| type_default
|
integer
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| parent_id
|
|
{| class="lltable" border=1
uuid
|-
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| href
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id
|
|
|}
uuid
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| _embedded
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| categories
|
|
string
|}
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _updated_categories
|
|
|}
|-
|-
! scope="row" align="left"| category <small><em>(optional)</em></small>
! scope="row" align="left"| _updated_category_versions
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| ETag
|
| ''Current value of the entity tag for the requested variant.''
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| Location
|
| ''The URL of the moved inventory.''
|}
|}
|-
====== <div id="CategoryCategories-MOVE-403">403</div> ======
! scope="row" align="left"| parent
Description
|
*  '''Permissions check failed.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|-
|-
! scope="row" align="left"| links
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
integer
|}
|}
|-
====== <div id="CategoryCategories-MOVE-404">404</div> ======
! scope="row" align="left"| items
Description
|
*  '''Destination category not found.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
|}
string
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| error_description
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
|
|}
uuid
|-
|-
! scope="row" align="left"| children
! scope="row" align="left"| error_code
|
|
integer
|}
====== <div id="CategoryCategories-MOVE-410">410</div> ======
Description
*  '''Source category gone'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_description
|
|
|}
string
|-
|-
! scope="row" align="left"| categories <small><em>(optional)</em></small>
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| error_code
|
|
integer
|}
|}
|}
====== <div id="CategoryCategories-MOVE-412">412</div> ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
string
integer
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| error_description
|
|
integer
string
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
uuid
string
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| etags
|
|
integer
array
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| etag
|
|
uuid
string
|-
|-
! scope="row" align="left"| category_id
! scope="row" align="left"| error_code
|
|
uuid
integer
|-
|-
! scope="row" align="left"| _embedded
! scope="row" align="left"| condition
|
|
{| class="lltable" border=1
string
|-
|-
! scope="row" align="left"| categories
|
|}
|}
|}
{| class="lltable" border=1
{| class="lltable" border=1
Line 8,096: Line 8,247:
| ''Current value of the entity tag for the requested variant.''
| ''Current value of the entity tag for the requested variant.''
|}
|}
====== CategoryCategories-GET-404 ======
<hr>
==== <div id="CategoryCategories-DELETE">DELETE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
Description
* '''Category not found'''
* '''Delete category categories'''
Response Schemas:
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| If-None-Match <small><em>(optional)</em></small>
|
| ''Only process request if none of the supplied entity tags matches resource.''
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| If-Match <small><em>(optional)</em></small>
|
| ''Only process request if any supplied entity tags matches resource.''
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
|}
====== CategoryCategories-GET-304 ======
===== Status Codes =====
====== <div id="CategoryCategories-DELETE-200">200</div> ======
Description
Description
*  '''Not modified'''
*  '''Category categories deleted successfully'''
Response Schemas:
Response Schemas:
string
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">categoryDeleteResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
| ''Current value of the entity tag for the requested variant.''
|
|}
====== CategoryCategories-GET-412 ======
Description
*  '''Precondition failed'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| code
|
|
string
integer
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| message
|
|
string
string
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| success
|
|
string
|}
|-
|-
! scope="row" align="left"| etags
! scope="row" align="left"| _attachments_removed
|
|
array
|-
|-
! scope="row" align="left"| etag
! scope="row" align="left"| _active_gestures_removed
|
|
string
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| _broken_links_removed
|
|-
! scope="row" align="left"| _total_items_removed
|
|
integer
integer
|-
|-
! scope="row" align="left"| condition
! scope="row" align="left"| _wearables_removed
|
|
string
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| _category_items_removed
|
|-
|-
! scope="row" align="left"| ETag
! scope="row" align="left"| _categories_removed
| ''Current value of the entity tag for the requested variant.''
|
|}
<hr>
=== Item ===
Description
* '''An inventory item.'''
Path:
* ''/item/''<code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{item}</code><code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{?tid,simulate}</code>
==== Parameters ====
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">tid</code> &rarr; Transaction ID.
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">item</code> &rarr; Item UUID
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">simulate</code> &rarr; Whether or not to skip writing back results.
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
<hr>
==== Item-MOVE ====
Description
* '''Move an item'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| Destination
|
| ''Destination category_id or 'special' category.''
|}
|}
===== Status Codes =====
====== <div id="CategoryCategories-DELETE-410">410</div> ======
====== Item-MOVE-200 ======
Description
Description
*  '''Item moved successfully'''
*  '''Category gone'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemMoveResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryGone</code>
|-
|-
|-
|-
! scope="row" align="left"| asset_id
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
uuid
integer
|-
|-
! scope="row" align="left"| inv_type
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
integer
string
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| error_description
|
|
string
string
|-
|-
! scope="row" align="left"| sale_info
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| sale_price
|
|
integer
uuid
|-
|-
! scope="row" align="left"| sale_type
! scope="row" align="left"| error_code
|
|
integer
integer
|}
|}
|-
====== <div id="CategoryCategories-DELETE-412">412</div> ======
! scope="row" align="left"| created_at
Description
|
*  '''Precondition failed'''
integer
Response Schemas:
|-
! scope="row" align="left"| parent_id <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| flags
|
integer
|-
! scope="row" align="left"| agent_id
|
uuid
|-
! scope="row" align="left"| item_id
|
uuid
|-
! scope="row" align="left"| permissions
|
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorPreconditionFailed</code>
|-
|-
|-
|-
! scope="row" align="left"| base_mask
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| group_mask
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
integer
string
|-
|-
! scope="row" align="left"| last_owner_id
! scope="row" align="left"| error_description
|
|
uuid
string
|-
|-
! scope="row" align="left"| owner_id
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
uuid
string
|-
|-
! scope="row" align="left"| creator_id
! scope="row" align="left"| etags
|
|
uuid
array
|-
|-
! scope="row" align="left"| next_owner_mask
! scope="row" align="left"| etag
|
|
integer
string
|-
|-
! scope="row" align="left"| owner_mask
! scope="row" align="left"| error_code
|
|
integer
integer
|-
|-
! scope="row" align="left"| group_id
! scope="row" align="left"| condition
|
|
uuid
string
|}
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| everyone_mask
|-
! scope="row" align="left"| ETag
| ''Current value of the entity tag for the requested variant.''
|}
<hr>
=== Item ===
Description
* '''An inventory item.'''
Path:
* ''/item/''<code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{item}</code><code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">{?tid,simulate}</code>
==== Parameters ====
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">tid</code> &rarr; Transaction ID.
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">item</code> &rarr; Item UUID
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$</code>
* <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">simulate</code> &rarr; Whether or not to skip writing back results.
** Validation: <code style="border: 1px solid #E1E1E8; color: #DD1144;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">^(0|1|true|false)?$</code>
<hr>
==== <div id="Item-GET">GET</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Retrieve an item'''
===== Status Codes =====
====== <div id="Item-GET-200">200</div> ======
Description
*  '''Item retrieved successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemResponse</code>
|-
|-
! scope="row" align="left"| _links
|
|
integer
{| class="lltable" border=1
|}
|-
|-
|-
! scope="row" align="left"| type
! scope="row" align="left"| self
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| desc
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| _updated_items
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| parent
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">linkMoveResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| linked_id
! scope="row" align="left"| href
|
|
uuid
string
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|}
|-
|-
! scope="row" align="left"| created_at
! scope="row" align="left"| _base_uri
|
|
string
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| asset_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| inv_type
|
|
uuid
integer
|-
! scope="row" align="left"| name
|
string
|-
! scope="row" align="left"| sale_info
|
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| item_id
! scope="row" align="left"| sale_price
|
|
uuid
integer
|-
|-
! scope="row" align="left"| inv_type
! scope="row" align="left"| sale_type
|
|
integer
integer
|}
|-
|-
! scope="row" align="left"| type
! scope="row" align="left"| created_at
|
|
integer
integer
|-
|-
! scope="row" align="left"| desc
! scope="row" align="left"| parent_id <small><em>(optional)</em></small>
|
|
string
uuid
|-
|-
! scope="row" align="left"| _updated_items
! scope="row" align="left"| flags
|
|
integer
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| agent_id
|
|
|}
uuid
{| class="lltable" border=1
|+Response Headers
|-
|-
! scope="row" align="left"| item_id
|
uuid
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| permissions
| ''The URL of the moved inventory.''
|
|}
====== Item-MOVE-404 ======
Description
*  '''Destination category not found.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| base_mask
|
|
integer
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| group_mask
|
|
string
integer
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| last_owner_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| owner_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| creator_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| next_owner_mask
|
|
integer
integer
|}
====== Item-MOVE-403 ======
Description
*  '''Permissions check failed.'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
! scope="row" align="left"| owner_mask
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| group_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| everyone_mask
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_code
|
|
integer
integer
|}
|}
====== Item-MOVE-410 ======
Description
*  '''Source item gone'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemGone</code>
|-
|-
|-
! scope="row" align="left"| type
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| desc
|
|
string
string
|}
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">linkResponse</code>
|-
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| _base_uri
|
|
string
string
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| _links
|
|
string
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| item_id
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| item
|
|
integer
|}
<hr>
==== Item-PATCH ====
Description
* '''Modify an item'''
===== Request Schemas =====
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">modifyItem</code>
|-
|-
|-
|-
! scope="row" align="left"| asset_id <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
uuid
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| sale_info <small><em>(optional)</em></small>
! scope="row" align="left"| category
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| sale_price <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| sale_type <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|}
|-
|-
! scope="row" align="left"| flags <small><em>(optional)</em></small>
! scope="row" align="left"| self
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| desc <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| hash_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| permissions <small><em>(optional)</em></small>
! scope="row" align="left"| parent
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| owner_mask <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| everyone_mask <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|}
|-
|-
! scope="row" align="left"| next_owner_mask <small><em>(optional)</em></small>
! scope="row" align="left"| _embedded
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| group_mask <small><em>(optional)</em></small>
! scope="row" align="left"| item
|
|
integer
|}
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">modifyLink</code>
|-
|-
|-
|-
! scope="row" align="left"| linked_id <small><em>(optional)</em></small>
! scope="row" align="left"| asset_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| inv_type
|
|
string
integer
|-
|-
! scope="row" align="left"| desc <small><em>(optional)</em></small>
! scope="row" align="left"| name
|
|
string
string
|}
===== Status Codes =====
====== Item-PATCH-200 ======
Description
*  '''Item modified successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemModifyResponse</code>
|-
|-
|-
! scope="row" align="left"| sale_info
! scope="row" align="left"| _links
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| sale_price
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| href
|
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|-
! scope="row" align="left"| parent
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| href
|
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|}
|-
! scope="row" align="left"| _base_uri
|
string
|-
! scope="row" align="left"| asset_id
|
uuid
|-
! scope="row" align="left"| inv_type
|
integer
|-
! scope="row" align="left"| name
|
string
|-
! scope="row" align="left"| sale_info
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| sale_price
|
|
integer
integer
Line 8,687: Line 8,732:
string
string
|-
|-
! scope="row" align="left"| _updated_items
! scope="row" align="left"| _links
|
|
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| code
! scope="row" align="left"| parent
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| message
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| success
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|}
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| category
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">linkModifyResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| name
|
|
string
string
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| type_default
|
|
{| class="lltable" border=1
integer
|-
|-
! scope="row" align="left"| parent_id
|
uuid
|-
|-
! scope="row" align="left"| item
! scope="row" align="left"| version
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| href
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| category_id
|
|
|}
uuid
|-
|-
! scope="row" align="left"| category
! scope="row" align="left"| _links
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| href
|
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| self
Line 8,781: Line 8,823:
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|}
|}
|}
|-
|-
! scope="row" align="left"| _embedded
! scope="row" align="left"| _broken
|
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| linked_id
|
uuid
|-
|-
! scope="row" align="left"| item
! scope="row" align="left"| name
|
|
{| class="lltable" border=1
string
|-
|-
! scope="row" align="left"| created_at
|
|-
|-
! scope="row" align="left"| asset_id
! scope="row" align="left"| parent_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| inv_type
! scope="row" align="left"| agent_id
|
uuid
|-
! scope="row" align="left"| item_id
|
uuid
|-
! scope="row" align="left"| inv_type
|
|
integer
integer
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| type
|
|
string
integer
|-
|-
! scope="row" align="left"| sale_info
! scope="row" align="left"| desc
|
|
string
|}
====== <div id="Item-GET-404">404</div> ======
Description
*  '''Item not found'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| sale_price
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| sale_type
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
|
integer
string
|}
|-
|-
! scope="row" align="left"| created_at
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
integer
string
|-
|-
! scope="row" align="left"| parent_id <small><em>(optional)</em></small>
! scope="row" align="left"| item_id <small><em>(optional)</em></small>
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| flags
! scope="row" align="left"| error_code
|
|
integer
integer
|}
<hr>
==== <div id="Item-PATCH">PATCH</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Modify an item'''
===== Request Schemas =====
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">modifyItem</code>
|-
|-
! scope="row" align="left"| agent_id
|-
! scope="row" align="left"| asset_id <small><em>(optional)</em></small>
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| item_id
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
string
|-
|-
! scope="row" align="left"| permissions
! scope="row" align="left"| sale_info <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| base_mask
! scope="row" align="left"| sale_price <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| group_mask
! scope="row" align="left"| sale_type <small><em>(optional)</em></small>
|
|
integer
integer
|}
|-
|-
! scope="row" align="left"| last_owner_id
! scope="row" align="left"| flags <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| desc <small><em>(optional)</em></small>
|
|
uuid
string
|-
|-
! scope="row" align="left"| owner_id
! scope="row" align="left"| hash_id <small><em>(optional)</em></small>
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| creator_id
! scope="row" align="left"| permissions <small><em>(optional)</em></small>
|
|
uuid
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| next_owner_mask
! scope="row" align="left"| owner_mask <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| owner_mask
! scope="row" align="left"| everyone_mask <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| group_id
! scope="row" align="left"| next_owner_mask <small><em>(optional)</em></small>
|
|
uuid
integer
|-
|-
! scope="row" align="left"| everyone_mask
! scope="row" align="left"| group_mask <small><em>(optional)</em></small>
|
|
integer
integer
|}
|}
|}
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">modifyLink</code>
|-
|-
! scope="row" align="left"| linked_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| type
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
string
|-
|-
! scope="row" align="left"| desc
! scope="row" align="left"| desc <small><em>(optional)</em></small>
|
|
string
string
|}
===== Status Codes =====
====== <div id="Item-PATCH-200">200</div> ======
Description
*  '''Item modified successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemModifyResponse</code>
|-
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| _links
Line 8,919: Line 9,019:
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|}
|}
|-
|-
! scope="row" align="left"| category
! scope="row" align="left"| _base_uri
|
|
{| class="lltable" border=1
string
|-
|-
|-
! scope="row" align="left"| asset_id
! scope="row" align="left"| name
|
|
string
uuid
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| inv_type
|
|
integer
integer
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| name
|
|
uuid
string
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| sale_info
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| sale_price
|
|
integer
integer
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| sale_type
|
|
uuid
integer
|}
|-
|-
! scope="row" align="left"| category_id
! scope="row" align="left"| created_at
|
|
uuid
integer
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| parent_id <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
uuid
|-
|-
|-
! scope="row" align="left"| flags
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| href
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| item_id
|
|
|}
uuid
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| permissions
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| base_mask
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| group_mask
|
|
|}
integer
|}
|}
|}
|-
|-
! scope="row" align="left"| _broken
! scope="row" align="left"| last_owner_id
|
|
uuid
|-
|-
! scope="row" align="left"| linked_id
! scope="row" align="left"| owner_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| creator_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| created_at
! scope="row" align="left"| next_owner_mask
|
|
integer
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| owner_mask
|
|
uuid
integer
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| group_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| item_id
! scope="row" align="left"| everyone_mask
|
uuid
|-
! scope="row" align="left"| inv_type
|
|
integer
integer
|}
|-
|-
! scope="row" align="left"| type
! scope="row" align="left"| type
Line 9,055: Line 9,153:
|
|
|}
|}
====== Item-PATCH-404 ======
Description
*  '''Item not found'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemNotFound</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">linkModifyResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| _base_uri
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| _links
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| item
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| item_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| category
|
|
integer
|}
====== Item-PATCH-400 ======
Description
*  '''Invalid request'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidItemRequest</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
integer
string
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
string
|}
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| self
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| item_id <small><em>(optional)</em></small>
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| parent
|
|
integer
|}
<hr>
==== Item-DELETE ====
Description
* '''Delete an item'''
===== Status Codes =====
====== Item-DELETE-200 ======
Description
*  '''Item deleted successfully'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemDeleteResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| _attachments_removed
! scope="row" align="left"| href
|
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|-
|-
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
! scope="row" align="left"| _embedded
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
! scope="row" align="left"| item
|
|
string
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
! scope="row" align="left"| asset_id
|
|
integer
uuid
|-
|-
! scope="row" align="left"| code
! scope="row" align="left"| inv_type
|
|
integer
integer
|-
|-
! scope="row" align="left"| message
! scope="row" align="left"| name
|
|
string
string
|-
|-
! scope="row" align="left"| success
! scope="row" align="left"| sale_info
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| sale_price
|
integer
|-
! scope="row" align="left"| sale_type
|
|
integer
|}
|}
|-
|-
! scope="row" align="left"| _active_gestures_removed
! scope="row" align="left"| created_at
|
|
integer
|-
|-
! scope="row" align="left"| _broken_links_removed
! scope="row" align="left"| parent_id <small><em>(optional)</em></small>
|
|
uuid
|-
|-
! scope="row" align="left"| _wearables_removed
! scope="row" align="left"| flags
|
|
integer
|-
|-
! scope="row" align="left"| _category_items_removed
! scope="row" align="left"| agent_id
|
|
uuid
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| item_id
|
uuid
|-
! scope="row" align="left"| permissions
|
|
|}
====== Item-DELETE-410 ======
Description
*  '''Item gone'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemGone</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| base_mask
|
|
integer
integer
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| group_mask
|
|
string
integer
|-
|-
! scope="row" align="left"| error_description
! scope="row" align="left"| last_owner_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
! scope="row" align="left"| owner_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| item_id
! scope="row" align="left"| creator_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| next_owner_mask
|
|
integer
integer
|}
<hr>
==== Item-COPY ====
Description
* '''Copy an item'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| owner_mask
|
integer
|-
|-
! scope="row" align="left"| Destination
! scope="row" align="left"| group_id
| ''Destination category_id or 'special' category.''
|
|}
uuid
===== Status Codes =====
====== Item-COPY-201 ======
Description
*  '''Item copied successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemCopyResponse</code>
|-
|-
|-
! scope="row" align="left"| everyone_mask
! scope="row" align="left"| asset_id
|
|
uuid
integer
|}
|-
|-
! scope="row" align="left"| inv_type
! scope="row" align="left"| type
|
|
integer
integer
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| desc
|
|
string
string
|-
|-
! scope="row" align="left"| sale_info
! scope="row" align="left"| _links
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| sale_price
! scope="row" align="left"| self
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| sale_type
! scope="row" align="left"| href
|
|
integer
string
|}
|-
|-
! scope="row" align="left"| created_at
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|-
|-
! scope="row" align="left"| parent_id <small><em>(optional)</em></small>
! scope="row" align="left"| parent
|
|
uuid
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| flags
|
integer
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| href
|
|
uuid
string
|-
|-
! scope="row" align="left"| item_id
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
uuid
|}
|}
|}
|-
|-
! scope="row" align="left"| permissions
! scope="row" align="left"| category
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| base_mask
! scope="row" align="left"| name
|
|
integer
string
|-
|-
! scope="row" align="left"| group_mask
! scope="row" align="left"| type_default
|
|
integer
integer
|-
|-
! scope="row" align="left"| last_owner_id
! scope="row" align="left"| parent_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| owner_id
! scope="row" align="left"| version
|
integer
|-
! scope="row" align="left"| agent_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| creator_id
! scope="row" align="left"| category_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| next_owner_mask
! scope="row" align="left"| _links
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| owner_mask
! scope="row" align="left"| self
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| group_id
! scope="row" align="left"| href
|
|
uuid
string
|-
|-
! scope="row" align="left"| everyone_mask
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
integer
|}
|}
|-
|-
! scope="row" align="left"| type
! scope="row" align="left"| parent
|
|
integer
{| class="lltable" border=1
|-
|-
|-
! scope="row" align="left"| desc
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| _created_items
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|
|}
|}
|}
|}
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| _broken
|
|
|}
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">linkCopyResponse</code>
|-
|-
|-
! scope="row" align="left"| linked_id
! scope="row" align="left"| linked_id
Line 9,368: Line 9,459:
string
string
|-
|-
! scope="row" align="left"| _created_items
! scope="row" align="left"| _updated_items
|
|
|-
|-
! scope="row" align="left"| _updated_category_versions
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
| ''The URL of the copied inventory.''
|
string
|-
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| code
|
integer
|-
! scope="row" align="left"| message
|
string
|-
! scope="row" align="left"| success
|
|}
|-
! scope="row" align="left"| _updated_category_versions
|
|}
|}
====== Item-COPY-410 ======
====== <div id="Item-PATCH-400">400</div> ======
Description
Description
*  '''Source item gone'''
*  '''Invalid request'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemGone</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidItemRequest</code>
|-
|-
|-
|-
Line 9,405: Line 9,514:
string
string
|-
|-
! scope="row" align="left"| item_id
! scope="row" align="left"| item_id <small><em>(optional)</em></small>
|
|
uuid
uuid
Line 9,413: Line 9,522:
integer
integer
|}
|}
====== Item-COPY-404 ======
====== <div id="Item-PATCH-404">404</div> ======
Description
Description
*  '''Destination category not found.'''
*  '''Item not found'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemNotFound</code>
|-
|-
|-
|-
Line 9,437: Line 9,546:
string
string
|-
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
! scope="row" align="left"| item_id <small><em>(optional)</em></small>
|
|
uuid
uuid
Line 9,445: Line 9,554:
integer
integer
|}
|}
====== Item-COPY-403 ======
<hr>
==== <div id="Item-COPY">COPY</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
Description
* '''Permissions check failed.'''
* '''Copy an item'''
Response Schemas:
===== Request Headers =====
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
! scope="row" align="left"| Destination
|
| ''Destination category_id or 'special' category.''
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_code
|
integer
|}
|}
<hr>
==== Item-GET ====
Description
* '''Retrieve an item'''
===== Status Codes =====
===== Status Codes =====
====== Item-GET-200 ======
====== <div id="Item-COPY-201">201</div> ======
Description
Description
*  '''Item retrieved successfully'''
*  '''Item copied successfully'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemResponse</code>
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemCopyResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| asset_id
|
|
{| class="lltable" border=1
uuid
|-
|-
|-
! scope="row" align="left"| inv_type
! scope="row" align="left"| self
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| sale_info
|
|}
|-
! scope="row" align="left"| parent
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| sale_price
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| sale_type
|
|
|}
integer
|}
|}
|-
|-
! scope="row" align="left"| _base_uri
! scope="row" align="left"| created_at
|
string
|-
! scope="row" align="left"| asset_id
|
uuid
|-
! scope="row" align="left"| inv_type
|
integer
|-
! scope="row" align="left"| name
|
string
|-
! scope="row" align="left"| sale_info
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| sale_price
|
integer
|-
! scope="row" align="left"| sale_type
|
integer
|}
|-
! scope="row" align="left"| created_at
|
|
integer
integer
Line 9,617: Line 9,671:
|
|
string
string
|}
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">linkResponse</code>
|-
|-
|-
! scope="row" align="left"| _created_items
! scope="row" align="left"| _base_uri
|
|
string
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| _updated_category_versions
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">linkCopyResponse</code>
|-
|-
|-
|-
! scope="row" align="left"| item
! scope="row" align="left"| linked_id
|
|
{| class="lltable" border=1
uuid
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| created_at
|
|
|}
|-
|-
! scope="row" align="left"| category
! scope="row" align="left"| parent_id
|
|
{| class="lltable" border=1
uuid
|-
|-
! scope="row" align="left"| agent_id
|
uuid
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| item_id
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| inv_type
|
|
|}
integer
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| type
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| desc
! scope="row" align="left"| href
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _created_items
|
|
|}
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| _updated_category_versions
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+Response Headers
|-
|-
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| Location
|
| ''The URL of the copied inventory.''
string
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
|
|}
|}
|}
====== <div id="Item-COPY-403">403</div> ======
|-
Description
! scope="row" align="left"| _embedded
*  '''Permissions check failed.'''
|
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
|-
|-
|-
|-
! scope="row" align="left"| item
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
! scope="row" align="left"| asset_id
|
|
uuid
string
|-
|-
! scope="row" align="left"| inv_type
! scope="row" align="left"| error_description
|
|
integer
string
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
string
string
|-
|-
! scope="row" align="left"| sale_info
! scope="row" align="left"| error_code
|
|
integer
|}
====== <div id="Item-COPY-404">404</div> ======
Description
*  '''Destination category not found.'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
|-
|-
! scope="row" align="left"| sale_price
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| sale_type
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
integer
string
|}
|-
|-
! scope="row" align="left"| created_at
! scope="row" align="left"| error_description
|
|
integer
string
|-
|-
! scope="row" align="left"| parent_id <small><em>(optional)</em></small>
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
uuid
string
|-
|-
! scope="row" align="left"| flags
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| agent_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| item_id
! scope="row" align="left"| error_code
|
uuid
|-
! scope="row" align="left"| permissions
|
|
integer
|}
====== <div id="Item-COPY-410">410</div> ======
Description
*  '''Source item gone'''
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemGone</code>
|-
|-
|-
|-
! scope="row" align="left"| base_mask
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
|
integer
integer
|-
|-
! scope="row" align="left"| group_mask
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
|
integer
string
|-
|-
! scope="row" align="left"| last_owner_id
! scope="row" align="left"| error_description
|
|
uuid
string
|-
|-
! scope="row" align="left"| owner_id
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
|
uuid
string
|-
|-
! scope="row" align="left"| creator_id
! scope="row" align="left"| item_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| next_owner_mask
! scope="row" align="left"| error_code
|
|
integer
integer
|}
<hr>
==== <div id="Item-MOVE">MOVE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #B94A48;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">NONE</code>'''
Description
* '''Move an item'''
===== Request Headers =====
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| owner_mask
|
integer
|-
|-
! scope="row" align="left"| group_id
! scope="row" align="left"| Destination
|
| ''Destination category_id or 'special' category.''
uuid
|}
===== Status Codes =====
====== <div id="Item-MOVE-200">200</div> ======
Description
*  '''Item moved successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemMoveResponse</code>
|-
|-
|-
! scope="row" align="left"| everyone_mask
! scope="row" align="left"| asset_id
|
|
integer
uuid
|}
|-
|-
! scope="row" align="left"| type
! scope="row" align="left"| inv_type
|
|
integer
integer
|-
|-
! scope="row" align="left"| desc
! scope="row" align="left"| name
|
|
string
string
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| sale_info
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| sale_price
|
|
{| class="lltable" border=1
integer
|-
|-
! scope="row" align="left"| sale_type
|
integer
|}
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| created_at
|
|
string
integer
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| parent_id <small><em>(optional)</em></small>
|
|
|}
uuid
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| flags
|
|
{| class="lltable" border=1
integer
|-
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| href
|
|
string
uuid
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| item_id
|
|
|}
uuid
|}
|}
|-
|-
! scope="row" align="left"| category
! scope="row" align="left"| permissions
|
|
{| class="lltable" border=1
{| class="lltable" border=1
|-
|-
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| base_mask
|
|
string
integer
|-
|-
! scope="row" align="left"| type_default
! scope="row" align="left"| group_mask
|
|
integer
integer
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| last_owner_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| version
! scope="row" align="left"| owner_id
|
|
integer
uuid
|-
|-
! scope="row" align="left"| agent_id
! scope="row" align="left"| creator_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| category_id
! scope="row" align="left"| next_owner_mask
|
|
uuid
integer
|-
|-
! scope="row" align="left"| _links
! scope="row" align="left"| owner_mask
|
|
{| class="lltable" border=1
integer
|-
|-
! scope="row" align="left"| group_id
|
uuid
|-
|-
! scope="row" align="left"| self
! scope="row" align="left"| everyone_mask
|
|
{| class="lltable" border=1
integer
|}
|-
|-
! scope="row" align="left"| type
|
integer
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| desc
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| _updated_items
|
|
|}
|-
|-
! scope="row" align="left"| parent
! scope="row" align="left"| _updated_category_versions
|
|
|}
{| class="lltable" border=1
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">linkMoveResponse</code>
|-
|-
|-
! scope="row" align="left"| linked_id
|
uuid
|-
|-
! scope="row" align="left"| href
! scope="row" align="left"| name
|
|
string
string
|-
|-
! scope="row" align="left"| name <small><em>(optional)</em></small>
! scope="row" align="left"| created_at
|
|-
! scope="row" align="left"| parent_id
|
|
|}
uuid
|}
|}
|}
|-
|-
! scope="row" align="left"| _broken
! scope="row" align="left"| agent_id
|
|
uuid
|-
|-
! scope="row" align="left"| linked_id
! scope="row" align="left"| item_id
|
|
uuid
uuid
|-
|-
! scope="row" align="left"| name
! scope="row" align="left"| inv_type
|
integer
|-
! scope="row" align="left"| type
|
integer
|-
! scope="row" align="left"| desc
|
|
string
string
|-
|-
! scope="row" align="left"| created_at
! scope="row" align="left"| _updated_items
|
|
|-
|-
! scope="row" align="left"| parent_id
! scope="row" align="left"| _updated_category_versions
|
|
uuid
|}
|-
{| class="lltable" border=1
! scope="row" align="left"| agent_id
|+Response Headers
|
|-
uuid
|-
|-
! scope="row" align="left"| Location
! scope="row" align="left"| item_id
| ''The URL of the moved inventory.''
|
|}
uuid
====== <div id="Item-MOVE-403">403</div> ======
|-
Description
! scope="row" align="left"| inv_type
*  '''Permissions check failed.'''
|
Response Schemas:
integer
{| class="lltable" border=1
|-
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorInvalidPermissions</code>
! scope="row" align="left"| type
|-
|
|-
integer
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|-
|
! scope="row" align="left"| desc
integer
|
|-
string
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|}
|
====== Item-GET-404 ======
string
Description
|-
*  '''Item not found'''
! scope="row" align="left"| error_description
Response Schemas:
|
{| class="lltable" border=1
string
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemNotFound</code>
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_code
|
integer
|}
====== <div id="Item-MOVE-404">404</div> ======
Description
*  '''Destination category not found.'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorCategoryNotFound</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| category_id <small><em>(optional)</em></small>
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
====== <div id="Item-MOVE-410">410</div> ======
Description
*  '''Source item gone'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemGone</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| item_id
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
<hr>
==== <div id="Item-DELETE">DELETE</div> ====
Implementation Status
* '''<code style="border: 1px solid #E1E1E8; color: #468847;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace; padding: 2px 4px;">COMPLETE</code>'''
Description
* '''Delete an item'''
===== Status Codes =====
====== <div id="Item-DELETE-200">200</div> ======
Description
*  '''Item deleted successfully'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">itemDeleteResponse</code>
|-
|-
! scope="row" align="left"| _attachments_removed
|
|-
! scope="row" align="left"| _update_result <small><em>(optional)</em></small>
|
{| class="lltable" border=1
|-
|-
! scope="row" align="left"| server_response <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| fault_code <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| code
|
integer
|-
! scope="row" align="left"| message
|
string
|-
! scope="row" align="left"| success
|
|}
|-
! scope="row" align="left"| _active_gestures_removed
|
|-
! scope="row" align="left"| _broken_links_removed
|
|-
! scope="row" align="left"| _wearables_removed
|
|-
! scope="row" align="left"| _category_items_removed
|
|-
! scope="row" align="left"| _updated_category_versions
|
|}
====== <div id="Item-DELETE-410">410</div> ======
Description
*  '''Item gone'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorItemGone</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| item_id
|
uuid
|-
! scope="row" align="left"| error_code
|
integer
|}
== Global Response Status Codes ==
=== <div id="Global-400">400</div> ===
Description
*  '''Invalid request'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorGeneral</code>
|-
|-
|-
|-
Line 9,947: Line 10,204:
|
|
string
string
|-
! scope="row" align="left"| item_id <small><em>(optional)</em></small>
|
uuid
|-
|-
! scope="row" align="left"| error_code
! scope="row" align="left"| error_code
Line 9,956: Line 10,209:
integer
integer
|}
|}
== Global Responses ==
=== <div id="Global-415">415</div> ===
=== Global-415 ===
Description
Description
*  '''Unsupported media type'''
*  '''Unsupported media type'''
Line 9,985: Line 10,237:
integer
integer
|}
|}
=== Global-500 ===
=== <div id="Global-500">500</div> ===
Description
Description
*  '''Internal Error'''
*  '''Internal Error'''
Response Schemas:
{| class="lltable" border=1
|+<code style="border: 1px solid #E1E1E8; color: #4411DD;  background-color: #F7F7F9; font-family: Monaco,Menlo,Consolas,monospace;">errorGeneral</code>
|-
|-
! scope="row" align="left"| error_line_number <small><em>(optional)</em></small>
|
integer
|-
! scope="row" align="left"| error_filename <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_description
|
string
|-
! scope="row" align="left"| error_function <small><em>(optional)</em></small>
|
string
|-
! scope="row" align="left"| error_code
|
integer
|}
=== Global-400 ===
Description
*  '''Invalid request'''
Response Schemas:
Response Schemas:
{| class="lltable" border=1
{| class="lltable" border=1

Revision as of 09:00, 4 October 2013

Resource Methods Overview

‡ - Not Implemented † - Partially 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)?$

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.

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.

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.

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.

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.

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.

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)?$

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.

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.

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.

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.

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)?$

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

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

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

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

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)?$

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.

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.

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.

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.

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)?$

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.

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.

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.

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.

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)?$

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

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

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

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

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=1182184"