webCOMAND

webCOMAND End Points

webCOMAND provides several end points to access content field values, including files and images.

Each end-point described below begins with a URL like:

https://<account>.webcomand.com/com_webcomand/<endpoint>

End Points

Each request to the end points below must include a session cookie for a valid active user session.  In other words, these end points are meant to be included in web apps that utilize the Users Framework, so the web app user's browser sends a corresponding session cookie automatically.

The cache/icon and icon end points do not require specific user authorizations beyond an active user session.  All other end points require the session user to be authorized to access the specified object and field.

default

Launch the webCOMAND User's default app.

cache

Handler for retrieving data from the object field cache, falling back on the download or img end points if not cached.

/com_webcomand/cache/<method>/<object doid>/<field doid>[/<dimensions>[/<grid size>]]
  • method - download, icon, image, img
  • object doid - DOID of the object that contains the field value to display.  Must end with a 'D'.
  • field doid - DOID of the field within the object that contains the value.  Must end with a 'D'.
  • dimensions - Optional width and height to resize the image to, in the form <width>x<height>.  Not valid for download method.
  • grid size - Optional box width/height of checkered grid to display in transparent areas of the image (a single numeric value).  Not valid for download method.

view

Request an object's field value.  The response will send the file or value in its native format, without the attachment content disposition that prompts the browser to download.

/com_webcomand/view/<object doid>/<field doid>
  • object doid - DOID of the object that contains the field value to download.  Must end with a 'D'.  An OID may also be provided without a 'D' at the end.
  • field doid - DOID of the field within the object that contains the value to download.  Must end with a 'D'.  An OID may also be provided without a 'D' at the end.

download

Request an object's field value as a download, so the web browser will display an Open/Save dialog or just download it.

/com_webcomand/download/<object doid>/<field doid>
  • object doid - DOID of the object that contains the field value to download.  Must end with a 'D'.  An OID may also be provided without a 'D' at the end.
  • field doid - DOID of the field within the object that contains the value to download.  Must end with a 'D'.  An OID may also be provided without a 'D' at the end.

icon

Handler for downloading an icon from the main framework (i.e. resized repository object icon). Serves the file in its native format with the attachment content disposition that prompts the browser to download.

/com_webcomand/icon/<object oid>[/<dimensions>[/<grid size>]]
  • object oid - OID of the object to display the icon for.
  • dimensions - Optional width and height to resize the image to, in the form <width>x<height>.
  • grid size - Optional box width/height of checkered grid to display in transparent areas of the image (a single numeric value).

image

Request an object's image based on the object's Content Type Image method.

For more information about the Image method, see Rich Text Settings.
/com_webcomand/image/<object doid>[/<dimensions>[/<grid size>]]
  • object doid - DOID of the object to display the icon for.  Must end with a 'D'.  An OID may also be provided without a 'D' at the end.
  • dimensions - Optional width and height to resize the image to, in the form <width>x<height>.
  • grid size - Optional box width/height of checkered grid to display in transparent areas of the image (a single numeric value).

img

Handler for downloading an image from the main framework (i.e. resized repository object icon). Serves the file in its native format with the attachment content disposition that prompts the browser to download.

/com_webcomand/img/<object doid>/<field doid>[/<dimensions>[/<grid size>]]
  • object doid - DOID of the object to display the icon for.  Must end with a 'D'.  An OID may also be provided without a 'D' at the end.
  • field doid - DOID of the field within the object that contains the value.  Must end with a 'D'.  An OID may also be provided without a 'D' at the end.
  • dimensions - Optional width and height to resize the image to, in the form <width>x<height>.
  • grid size - Optional box width/height of checkered grid to display in transparent areas of the image (a single numeric value).

show-wc-icons

Display the list of CSS classes that can be used to access the icons available through the webCOMAND font.

/com_webcomand/show-wc-icons

To access these classes, link to the webCOMAND styles with:

<link type="text/css" rel="stylesheet" href="https://<account>.webcomand.com/com_webcomand/css/styles.css" />