Asset Attributes
This chapter outlines the asset attributes for the assets available in the Web Services package, including the SOAP Server and the Javascript API.
Bookmarks to the headings on this page:
- Web Services Folder
- Squiz Suite Manager
- SOAP Server
- SOAP API Asset Service
- SOAP API Design Lookup Service
- SOAP API File Retrieval Service
- SOAP API Link Service
- SOAP API Metadata Service
- SOAP API Permission & Role Service
- SOAP API Search Service
- SOAP API Workflow Service
- Javascript API
- REST Resource
- REST Resource JavaScript
- REST Resource OAuth Session
Web Services Folder
| Attribute (Type) | Description |
|---|---|
| name (text) | - |
Squiz Suite Manager
| Attribute (Type) | Description |
|---|---|
| name (text) | - |
| short_name (text) | - |
SOAP Server
| Attribute (Type) | Description |
|---|---|
| list_api (serialise) | APIs available to this service field settings (Details screen) |
| name (text) | Page Name field input (Details screen) |
| short_name (text) | Page Short Name field input (Details screen) |
SOAP API Asset Service
| Attribute (Type) | Description |
|---|---|
| function_list (serialise) | Function List field settings (Details screen) |
| name (text) | SOAP Server API Name field input (Details screen) |
| short_name (text) | SOAP Server API Short Name field input (Details screen) |
SOAP API Design Lookup Service
| Attribute (Type) | Description |
|---|---|
| function_list (serialise) | Function List field settings (Details screen) |
| name (text) | SOAP Server API Name field input (Details screen) |
| short_name (text) | SOAP Server API Short Name field input (Details screen) |
SOAP API File Retrieval Service
| Attribute (Type) | Description |
|---|---|
| function_list (serialise) | Function List field settings (Details screen) |
| name (text) | SOAP Server API Name field input (Details screen) |
| short_name (text) | SOAP Server API Short Name field input (Details screen) |
SOAP API Link Service
| Attribute (Type) | Description |
|---|---|
| function_list (serialise) | Function List field settings (Details screen) |
| name (text) | SOAP Server API Name field input (Details screen) |
| short_name (text) | SOAP Server API Short Name field input (Details screen) |
SOAP API Metadata Service
| Attribute (Type) | Description |
|---|---|
| function_list (serialise) | Function List field settings (Details screen) |
| name (text) | SOAP Server API Name field input (Details screen) |
| short_name (text) | SOAP Server API Short Name field input (Details screen) |
SOAP API Permission & Role Service
| Attribute (Type) | Description |
|---|---|
| function_list (serialise) | Function List field settings (Details screen) |
| name (text) | SOAP Server API Name field input (Details screen) |
| short_name (text) | SOAP Server API Short Name field input (Details screen) |
SOAP API Search Service
| Attribute (Type) | Description |
|---|---|
| function_list (serialise) | Function List field settings (Details screen) |
| name (text) | SOAP Server API Name field input (Details screen) |
| short_name (text) | SOAP Server API Short Name field input (Details screen) |
SOAP API Workflow Service
| Attribute (Type) | Description |
|---|---|
| function_list (serialise) | Function List field settings (Details screen) |
| name (text) | SOAP Server API Name field input (Details screen) |
| short_name (text) | SOAP Server API Short Name field input (Details screen) |
Javascript API
| Attribute (Type) | Description |
|---|---|
| acquire_lock (boolean) | Acquire Lock field setting (Details screen) |
| allow_json (boolean) | Return JSON field setting (Details screen) |
| api_key (text) | API Key field input (Details screen) |
| create_asset (boolean) | Create Asset field setting (Details screen) |
| create_attributes (boolean) | Allow Attributes on Create field setting (Details screen) |
| create_link (boolean) | Create Link field setting (Details screen) |
| force_simple_edit (boolean) | Force Simple Edit field setting (Details screen) |
| get_asset_tree (boolean) | Get Asset Tree field setting (Details screen) |
| get_asset_types (boolean) | Get Asset Types field setting (Details screen) |
| get_attributes (boolean) | Get Attributes field setting (Details screen) |
| get_children (boolean) | Get Children field setting (Details screen) |
| get_general (boolean) | Get General Info field setting (Details screen) |
| get_keyword_replacements (boolean) | Get Keyword Replacements field setting (Details screen) |
| get_link_id (boolean) | Get Link id field setting (Details screen) |
| get_locks_info (boolean) | Get Locks Info field setting (Details screen) |
| get_metadata (boolean) | Get Metadata field setting (Details screen) |
| get_parents (boolean) | Get Parents field setting (Details screen) |
| get_permissions (boolean) | Get Permissions field setting (Details screen) |
| get_roles (boolean) | Get Roles Information field setting (Details screen) |
| get_web_path (boolean) | Get Asset WebPath(s) field setting (Details screen) |
| get_workflow_schema (boolean) | Get Workflow Schema field setting (Details screen) |
| ignore_permissions (boolean) | Ignore Permissions field setting (Details screen) |
| import_assets (boolean) | Import Assets from XML field setting (Details screen) |
| move_link (boolean) | Move Link field setting (Details screen) |
| name (text) | Javascript API Name field input (Details screen) |
| release_lock (boolean) | Release Lock field setting (Details screen) |
| remove_link (boolean) | Remove Link field setting (Details screen) |
| root_node (assetid) | Root Nodes field settings (Details screen) |
| set_asset_status (boolean) | Set Assut Status field setting (Details screen) |
| set_attribute (boolean) | Set Attribute field setting (Details screen) |
| set_file_content (boolean) | Set File Content field setting (Details screen) |
| set_metadata (boolean) | Set Metadata field setting (Details screen) |
| set_web_path (boolean) | Set Asset WebPath field setting (Details screen) |
| short_name (text) | Javascript API Short Name field input (Details screen) |
| trash_asset (boolean) | Trash Asset field setting (Details screen) |
| types (serialise) | Asset Types to Create field settings (Details screen) |
| type_restriction (serialise) | Parent Types field settings (Details screen) |
| update_link (boolean) | Update Link field setting (Details screen) |
REST Resource
| Attribute (Type) | Description |
|---|---|
| allow_multiple_runs (boolean) | Allow Multiple Runs field setting (Details screen) |
| error_response (text) | Error Response field input (Details screen) |
| http_request (http_request) | HTTP Request field settings (Details screen) |
| name (text) | Page Name field input (Details screen) |
| send_headers (boolean) | Send Headers field setting (Details screen) |
| short_name (text) | Page Short Name field input (Details screen) |
REST Resource JavaScript
| Attribute (Type) | Description |
|---|---|
| allow_multiple_runs (boolean) | Allow Multiple Runs field setting (Details screen) |
| error_response (text) | - |
| http_request (http_request) | HTTP Request field settings (Details screen) |
| javascript (text) | JavaScript field input (Details screen) |
| javascrip_files (serialise) | Include Files field settings (Details screen) |
| name (text) | Page Name field input (Details screen) |
| send_headers (boolean) | - |
| short_name (text) | Page Short Name field input (Details screen) |
REST Resource OAuth Session
| Attribute (Type) | Description |
|---|---|
| allow_multiple_runs (boolean) | - |
| error_response (text) | - |
| http_request (http_request) | - |
| name (text) | Page Name field input (Details screen) |
| oauth (oauth) | OAuth Parameters field settings (Details screen) |
| send_headers (boolean) | - |
| short_name (text) | Page Short Name field input (Details screen) |