INTRODUCTION

The Cattura CaptureCast HTTP API allows you to control the CaptureCast programmatically. This can be used for example to integrate it with third-party platforms like Crestron, Extron, AMX etc. To access this API documentation via your CaptureCast unit go to the units IP address followed by /api/1/docs (Example shown below: 192.168.3.236/api/1/docs/).

Tip: If you click on a Method Call it'll open another page with more information on how to form the command and even a way to test.



AUTHENTICATIONS

Some API methods require authentication. At the moment, authentication to the API is performed using HTTP Basic Authentication, supplying the username and password of a user with the required permissions. In the future, we will support API token authentication. If the documentation for the method does not state that it requires "any valid user" or that it requires specific permissions, then the method does not require any authentication.


AUTHORIZATIONS AND PERMISSIONS

Some API methods, in addition to requiring authentication, also require that the user has the correct permission to use the method. The user roles, and their associated permissions, are:

  • Administrator: all permissions
  • Scheduler: view, manage schedule
  • Content manager: view, manage media
  • Status viewer: view
  • Presenter: view

API URLs

URLs exposed by the API generally represent resources (such as templates or media packages) or actions (such as start capture or stop capture). API URLs sometimes require parameters such as {id}; these URLs follow the URI Templates format (see also RFC 6570).

Resource URLs

For a type of "thing" (for example "template," "mediaPackage," "speaker," etc.), URLs generally take the following forms:

  • /api/things
    • GET results in a listing of things.
    • POST results in a new thing being created.
  • /api/things/{id}
    • GET returns the thing indicated by id.
    • POST updates the thing indicated by id.
    • DELETE deletes the thing indicated by id.

REQUEST DATA

Request data is sent as Content-Type: application/x-www-form-urlencoded, which is the same data serialization used in HTML forms. Values for invididual parameters may either be primitive values or JSON-encoded objects.

OBJECT TYPES

In addition to JSON data types such as string, number, array, and object, the CaptureCast platform also has types of objects specific to it. These include:

CLIENTS

The CaptureCast API Plugin automatically generates small client libraries for a handful of languages:

At the moment these bindings are single-file and not very well documented.


METHODS FOR CAPTURE

  • startCapture    -    Start a capture session.
  • stopCapture    -    Stop a capture session.
  • pauseCapture    -    Pause a capture session.
  • resumeCapture    -    Resume a paused capture session.
  • isDeviceCaptureAvailable    -    Device capture is available if at least one device capture plugin is installed.
  • isConcurrentCaptureEnabled    -    Whether concurrent captures is enabled.
  • getTemplates    -    Returns the list of templates on this capture unit.
  • getTemplate    -    Returns a single template on this capture unit.
  • deleteTemplate    -    Deletes a template.
  • testTemplate    -    Performs a 10 second test of a capture template.
  • createTemplate    -    Deletes a template.
    • Method URL:    POST templates
    • Authentication:    none
    • Example:    curl -X POST -d 'id=' -d 'title=' -d 'description=' -d 'graph=' -d 'graphPath=' -d 'options=' 'http://192.168.3.236/api/1.0/templates'

  • getMediaPackages    -    Returns a list of media packages on this unit.
  • getMediaPackage    -    Returns a single media package on this capture unit.
  • attachToMediaPackage    -    Attaches an output element to a media package.
    • Method URL:    POST mediaPackages/{id}/outputs/{key}
    • Authentication:    none
    • Example:    curl -X POST -d 'element=' 'http://192.168.3.236/api/1.0/mediaPackages/{id}/outputs/{key}'

  • deleteMediaPackage    -    Deletes a media package.
    • Method URL:    DELETE mediaPackage/{id}
    • Authentication:    none
    • Example:    curl -X DELETE 'http://192.168.3.236/api/1.0/mediaPackages/{id}'

  • publishMediaPackage    -    Publish a media package.
    • Method URL:    POST mediaPackages/{id}/publish
    • Authentication:    none
    • Example:    curl -X POST -d 'publishRequest=' 'http://192.168.3.236/api/1.0/mediaPackages/{id}/publish'

  • testPublisherConfiguration    -    Test a publishing configuration.
    • Method URL:    POST publishing/test
    • Authentication:    none
    • Example:    curl -X POST -d 'publishrequest=' 'http://192.168.3.236/api/1.0/publishing/test'

  • getSavedConfigurations    -    Get tested configurations.
    • Method URL:    GET publishing/configurations
    • Authentication:    any valid user
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/publishing/configurations?id='

  • updateSavedConfiguration    -    Update a configuration.
    • Method URL:    POST publishing/configurations/{id}/{timestamp}
    • Authentication:    any valid user
    • Example:    curl -X POST -d 'config=' 'http://192.168.3.236/api/1.0/publishing/configurations/{id}/{timestamp}'

  • deleteSavedConfiguration    -    Delete a configuration.
    • Method URL:    DELETE publishing/configurations/{id}/{timestamp}
    • Authentication:    any valid user
    • Example:    curl -X DELETE 'http://192.168.3.236/api/1.0/publishing/configurations/{id}/{timestamp}'


METHODS FOR USER SESSIONS

  • startSession    -    Start a user session. Returns the session id.
    • Method URL:    POST userSessions/start
    • Authentication:    none
    • Example:    curl -X POST -d 'username='' -d 'password=' 'http://192.168.3.236/api/1.0/userSessions/start'

  • getSessionUser    -    Get user info for a session. Returns null (404) if session does not exist.
    • Method URL:    GET userSessions/{id}/user
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/userSessions/{id}/user'

  • stopSession    -    Stop a user session.
    • Method URL:    DELETE userSessions/{id}
    • Authentication:    none
    • Example:    curl -X DELETE 'http://192.168.3.236/api/1.0/userSessions/{id}'

METHOD FOR API

  • multicall   -    Perform a multicall.
    • Method URL:    POST api/multicall
    • Authentication:    none
    • Example:    curl -X POST -d 'calls=' 'http://192.168.3.236/api/1.0/api/multicall'


METHODS FOR EVENTS

  • events    -    CaptureCast event source.
    • Method URL:    GET events
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/events?receiveUserInterfaceEvents=&receiveInternalEvents='


METHODS FOR STATUS

  • getUnitStatus    -    Obtain general information about the current state of the recorder.
    • Method URL:    GET status
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/status?since='

  • getUnitInfo    -    Get basic information about the recorder.
    • Method URL:    GET status/unit
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/status/unit'

  • getNetworkInfo    -    Gets information about the network connectivity of the recorder.
    • Method URL:    GET status/network
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/status/network'

  • getDiskSpaceInfo    -    Gets the amount of free, usable, and total disk space.
    • Method URL:    GET status/space
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/status/space'

  • getCaptureState    -    Returns the current capture's state (idle, capturing, processing, etc)
    • Method URL:    GET status/capture
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/status/capture'

  • getConnectedDevices    -    Returns a listing of audio and video devices connected to this recorder.
    • Method URL:    GET status/devices
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/status/devices'

  • getTodaysSchedule    -    Returns all the scheduled captures for today.
    • Method URL:    GET status/schedule
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/status/schedule'

METHODS FOR SETTINGS

  • getSetting    -    Returns a single user setting for this recorder.
  • setSetting   -    Update a single user settings on this recorder. Returns the updated value of the setting.
  • getSettings    -    Returns all user settings for the recorder.
  • setSettings   -    Update multiple user settings on the recorder. Returns an updated set of all of the settings on the recorder. Will not erase other settings.
    • Method URL:    POST settings
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST -d 'settings=' 'http://192.168.3.236/api/1.0/settings'

METHODS FOR USERS

  • getUsers   -    List out all local users in CaptureCast.
    • Method URL:    GET users
    • Authentication:    This method requires the following permissions:    manage users
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/users'

  • getUser   -    Get information for a single local user in CaptureCast.
  • createUser   -    Create a new local user in CaptureCast.
    • Method URL:    POST users
    • Authentication:    This method requires the following permissions:    manage users
    • Example:    curl -X POST -d 'username=' -d 'password=' -d 'roles=' -d 'emailAddress=' 'http://192.168.3.236/api/1.0/users'

  • updateUser   -    Update a new local user in CaptureCast.
    • Method URL:    POST users/{id}
    • Authentication:    This method requires the following permissions:    manage users
    • Example:    curl -X POST -d 'username=' -d 'password=' -d 'roles=' -d 'emailAddress=' 'http://192.168.3.236/api/1.0/users/{id}'

  • deleteUser   -    Delete a local user in CaptureCast.
    • Method URL:    DELETE users/{id}
    • Authentication:    This method requires the following permissions:    manage users
    • Example:    curl -X DELETE 'http://192.168.3.236/api/1.0/users/{id}'

  • getRoles   -    Get all available roles in CaptureCast.
    • Method URL:    GET roles
    • Authentication:    This method requires the following permissions:    manage users
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/roles'

METHODS FOR SCHEDULER


  • createEventGroup    -    Schedule a group of captures.
    • Method URL:    POST scheduler/groups
    • Authentication:    none
    • Example:    curl -X POST -d 'presentationTitle=' -d 'template=' -d 'speaker=' -d 'duration=' -d 'startTime=' -d 'recurrenceEnd=' -d 'days=' -d 'tags=' -d 'assets=' 'http://192.168.3.236/api/1.0/scheduler/groups'

  • updateEventGroup    -    Update a group of captures.
    • Method URL:    POST scheduler/groups/{id}
    • Authentication:    none
    • Example:    curl -X POST -d 'presentationTitle=' -d 'template=' -d 'speaker=' -d 'duration=' -d 'startTime=' -d 'recurrenceEnd=' -d 'days=' -d 'tags=' -d 'assets=' 'http://192.168.3.236/api/1.0/scheduler/groups/{id}'

  • getEventGroup    -    Get information about a group.
  • getEventsForGroup    -    Get a set of scheduled captures in the specified event group.
  • deleteEventGroup    -    Delete group of captures, and all events it contains.
  • getEvents    -    Get a set of scheduled captures matching certain criteria, sorted by start date ascending (i.e. earliest first).
    • Method URL:    GET scheduler/events
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/scheduler/events?speaker=&range=&rangeStart=&rangeEnd=&limit=&status='

  • createEvent    -    Schedule a capture.
    • Method URL:    POST scheduler/events
    • Authentication:    none
    • Example:    curl -X POST -d 'presentationTitle=' -d 'template=' -d 'speaker=' -d 'duration=' -d 'startTime=' -d 'tags=' 'http://192.168.3.236/api/1.0/scheduler/events'

  • updateEvent    -    Update a scheduled a capture.
    • Method URL:    POST scheduler/events/{id}
    • Authentication:    none
    • Example:    curl -X POST -d 'presentationTitle=' -d 'template=' -d 'speaker=' -d 'duration=' -d 'startTime=' -d 'tags=' -d 'assets=' 'http://192.168.3.236/api/1.0/scheduler/events/{id}'

  • getEvent    -    Get information about a scheduled capture. The return value resembles that returned from getEvents but with more details.
  • deleteEvent    -    Delete the event at the given ID.


METHODS FOR MAINTENANCE

  • reboot   -    Perform a reboot on this recorder.
    • Method URL:    POST maintenance/reboot
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/maintenance/reboot'

  • poweroff   -    Power off the recorder.
    • Method URL:    POST maintenance/poweroff
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/maintenance/poweroff'

  • restart   -    Perform a restart of CaptureCast service.
    • Method URL:    POST maintenance/restart
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/maintenance/restart'

  • shutdown   -    Shut down the CaptureCast service.
    • Method URL:    POST maintenance/shutdown
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/maintenance/shutdown'

  • restartMediaProcessingModule   -    Restarts only the media processing components.
    • Method URL:    POST maintenance/restartMediaProcessingModule
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/maintenance/restartMediaProcessingModule'

  • runMaintenance   -    Runs maintenance on the operating system. May result in a reboot.
    • Method URL:    POST maintenance/runMaintenance
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/maintenance/runMaintenance'


METHODS FOR PLUGINS

  • getPlugins   -    Returns a list of all plugins installed in CaptureCast.
    • Method URL:    GET plugins
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/plugins'

  • getSettingsForPlugin   -    Retrieve user settings for a plugin.
    • Method URL:    GET plugins/{plugin}/settings
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/plugins/{plugin}/settings'

  • setSettingsForPlugin   -    Set user settings for a plugin.
    • Method URL:    POST plugins/{plugin}/settings
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST -d 'settings=' 'http://192.168.3.236/api/1.0/plugins/{plugin}/settings'

  • callPluginService   -    Invoke a service provided by a plugin.
    • Method URL:    POST plugins/{plugin}/{service}
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X POST -d 'args=' 'http://192.168.3.236/api/1.0/plugins/{plugin}/{service}'

METHODS FOR DEVICES

  • getAudioDevices   -    Returns a listing of known audio devices.
    • Method URL:    GET devices/audio
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/devices/audio'

  • getAudioDevice   -    Returns a single specified audio devices.
    • Method URL:    GET devices/audio/{id}
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/devices/audio/{id}'

  • getVideoDevices   -    Returns a listing of known video devices
    • Method URL:    GET devices/video
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/devices/video'

  • getVideoDevice   -    Returns a single specified video device.
    • Method URL:    GET devices/video/{id}
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/devices/video/{id}'

  • getVideoDeviceThumbnail   -    Returns the thumbnail for single specified video device.
    • Method URL:    GET devices/video/{id}/thumbnail
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/devices/video/{id}/thumbnail'

  • redetect   -    Redetect all devices on the recorder.
    • Method URL:    POST devices/redetect
    • Authentication:    This method requires the following permissions:    manage devices
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/devices/redetect'

  • redetectProgress   -    Redetect all devices on the recorder.
    • Method URL:    GET devices/redetect/progress
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/devices/redetect'/progress'

METHOD FOR TIME

  • getCurrentTime  -    Get the current time, as milliseconds since epoch.
    • Method URL:    GET time
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/time'

METHODS FOR NOTIFIERS

  • getNotifiers   -    Get all notifiers registered in CaptureCast.
    • Method URL:    GET notifiers
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/notifiers'

  • getNotifier   -    Get a single notifier registered in CaptureCast.
    • Method URL:    GET notifiers/{id}
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/notifiers/{id}'

  • deleteNotifier   -    Delete a notifier from CaptureCast.
    • Method URL:    DELETE notifiers/{id}
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X DELETE 'http://192.168.3.236/api/1.0/notifiers/{id}'

  • createNotifier   -    Create a notifier in CaptureCast.
    • Method URL:    POST notifiers
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST -d 'plugin=' -d 'args=' 'http://192.168.3.236/api/1.0/notifiers'

  • updateNotifier   -    Update an existing notifier in CaptureCast.
    • Method URL:    POST notifiers/{id}
    • Authentication:    This method requires the following permissions:    manage settings
    • Example:    curl -X POST -d 'args=' 'http://192.168.3.236/api/1.0/notifiers/{id}'

METHODS FOR LIVESTREAM VIEWER

  • createPreviewForSession   -    Create a preview for the current running recording.
    • Method URL:    POST sessions/{id}/preview
    • Authentication:    none
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/sessions/{id}/preview'

  • getPreviewForVideoDevice   -    Get a preview for a video device.
    • Method URL:    GET devices/video/{deviceId}/preview
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/devices/video/{deviceId}/preview'

  • getPreviewForAudioDevice   -    Get a preview for a audio device.
    • Method URL:    GET devices/audio/{deviceId}/preview
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/devices/audio/{deviceId}/preview'

  • createPreviewForVideoDevice   -    Create a preview for a video device.
    • Method URL:    POST devices/video/{deviceId}/preview
    • Authentication:    none
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/devices/video/{deviceId}/preview'

  • createPreviewForAudioDevice   -    Create a preview for a audio device.
    • Method URL:    POST devices/audio/{deviceId}/preview
    • Authentication:    none
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/devices/audio/{deviceId}/preview'

  • getPreviewForCurrentRecording   -    Get the preview for the current running recording, if it exists.
    • Method URL:    GET capture/preview
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/capture/preview'

  • createPreviewForCurrentRecording   -    Create a preview for the current running recording.
    • Method URL:    POST capture/preview
    • Authentication:    none
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/capture/preview'

  • getPreviewForSession   -    Get the preview for the specified session.
    • Method URL:    GET sessions/{id}/preview
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/sessions/{id}/preview'


METHODS FOR UPLOAD

  • getUploadedFiles   -    Get all uploaded files.
    • Method URL:    GET upload/files
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/upload/files'

  • getUploadedFilesWithTag   -    Get all uploaded files with the matching tag.
    • Method URL:    GET upload/files/{tag}
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/upload/files/{tag}'

  • getUploadedFile   -    Get an uploaded file.
    • Method URL:    GET upload/files/{hash}/{name}
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/upload/files/{hash}/{name}'

  • deleteUploadedFile   -    Delete an uploaded file.
    • Method URL:    DELETE upload/files/{hash}/{name}
    • Authentication:    none
    • Example:    curl -X DELETE 'http://192.168.3.236/api/1.0/upload/files/{hash}/{name}'

  • uploadFile   -    Upload one or more files, specified as multipart/form-data, with filenames as the form keys.
    • Method URL:    POST upload/files
    • Authentication:    none
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/upload/files'

  • uploadFileWithTag   -    Upload one or more files, specified as multipart/form-data, with filenames as the form keys, with a given tag.
    • Method URL:    POST upload/files/{tag}
    • Authentication:    none
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/upload/files/{tag}'


METHODS FOR graphBUILDER

  • apiWrapper   -    Returns a friendly wrapper for the graph builder API.
    • Method URL:    GET graphBuilder/graph.js
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/graphBuilder/graph.js'

  • listGraphs   -    Return a list of all saved graphs.
    • Method URL:    GET graphBuilder
    • Authentication:    none
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/graphBuilder'

  • save   -    Saves the current graph in memory to the filestystem.
    • Method URL:    POST graphBuilder/{root}/save
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/graphBuilder/{root}/save'

  • copy   -    Create a copy of an existing graph with a new root.
    • Method URL:    POST graphBuilder/{root}/copy
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/graphBuilder/{root}/copy'

  • createNode   -    Construct a processor node and attach it to a graph.
    • Method URL:    POST graphBuilder/{root}/createNode
    • Authentication:    This method requires the following permissions:    view
    • Example:    curl -X POST -d 'pluginID=' -d 'config=' -d 'parentNodeIDs=' 'http://192.168.3.236/api/1.0/graphBuilder/{root}/createNode'

  • startCapture   -    Start a session at this graph location.
    • Method URL:    POST graphBuilder/{root}/startCapture
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/graphBuilder/{root}/startCapture'

  • stopCapture   -    Stop a session at this graph location, if there is one.
    • Method URL:    POST graphBuilder/{root}/stopCapture
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/graphBuilder/{root}/stopCapture'

  • linkNode  -    Attach a node to one or more parents and/or children.
    • Method URL:    POST graphBuilder/{root}/nodes/{nodeId}/link
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X POST -d 'parentNodeIDs=' -d 'childNodeIDs=' 'http://192.168.3.236/api/1.0/graphBuilder/{root}/nodes/{nodeID}/link'

  • nodeOptions   -    Retrieve the options for this node.
    • Method URL:    GET graphBuilder/{root}/nodes/{nodeId}/options
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/graphBuilder/{root}/nodes/{nodeId}/options'

  • configureNode   -    Configure the specified node.
    • Method URL:    GET graphBuilder/{root}/nodes/{nodeId}/configure
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X POST -d 'config=' 'http://192.168.3.236/api/1.0/graphBuilder/{root}/nodes/{nodeID}/configure'

  • invokeService  -    Invokes a service of this Processor.
    • Method URL:    POST graphBuilder/{root}/nodes/{nodeId}/services/{service}
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X POST -d 'args=' 'http://192.168.3.236/api/1.0/graphBuilder/{root}/nodes/{nodeID}/services/{service}'

  • getNode   -    Get a single node from the graph.
    • Method URL:    GET graphBuilder/{root}/nodes/{nodeId}
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/graphBuilder/{root}/nodes/{nodeId}'

  • removeNode   -    Retrieve the options for this node.
    • Method URL:    DELETE graphBuilder/{root}/nodes/{nodeId}
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X DELETE 'http://192.168.3.236/api/1.0/graphBuilder/{root}/nodes/{nodeId}'

  • getGraph   -    Get the complete JSON text of a graph.
    • Method URL:    GET graphBuilder/{root}
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/graphBuilder/{root}'

  • make   -    Create an new graph with a root node.
    • Method URL:    POST graphBuilder/{root}
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X POST 'http://192.168.3.236/api/1.0/graphBuilder/{root}'


METHOD FOR SESSION STATUS

  • allNodes   -    Get the current status of each node in a capture session.
    • Method URL:    GET sessionStatus/{root}/nodes
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/sessionStatus/{root}/nodes'



METHODS FOR SESSION OUTPUT

  • forNode   -    For this specific node, get all files that it produced.
    • Method URL:    GET sessionOutput/{root}/nodes/{nodeID}
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/sessionOutput/{root}/nodes/{nodeID}'

  • getFile   -    For this specific node, get a specific file it produced.
    • Method URL:    GET sessionOutput/{root}/nodes/{nodeID}/{fileName}
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/sessionOutput/{root}/nodes/{nodeID}/{fileName}'

  • forAllNodes   -    For this specific node, get all files that it produced.
    • Method URL:    GET sessionOutput/{root}
    • Authentication:    The method requires the following permissions:    view
    • Example:    curl -X GET 'http://192.168.3.236/api/1.0/sessionOutput/{root}'