( Return to API Overview )

Available methods

Description

Provides methods to access and modify many aspects of configuration channels.

Namespace: configchannel

Method: create

Description:
Create a new global config channel. Caller must be at least a config admin or an organization admin.

Parameters:

string sessionKey
string channelLabel
string channelName
string channelDescription

Returns: struct (config channel)

 int "id" - Config channel ID.
 string "label" - Config channel label.
 string "name" - Config channel name.
 string "description"
 int "org_id"
 struct (config channel type)
  int "id" 
 string "label"
 string "name"
 int "priority"

Method: createOrUpdatePath

Description:
Create a new file or directory with the given path, or update an existing path.

Parameters:

string sessionKey
string configChannelLabel
string path
boolean isDir - True if the path is a directory, False if it is a file.
struct (path info)
- string "contents" - Contents of the file (text or base64 encoded if binary), ignored if working with a directory.
- string "owner" - Owner of the file/directory.
- string "group" - Group name of the file/directory.
- string "permissions" - Octal file/directory permissions (eg: 644)
- string "macro-start-delimiter" - Config file macro start delimiter. Use null or empty string to accept the default. (ignored if working with a directory)
- string "macro-end-delimiter" - Config file macro end delimiter. Use null or empty string to accept the default. (ignored if working with a directory)

Returns: struct (config revision)

 string "path"
 string "type" - "file" or "directory".
 int "revision"
 dateTime.iso8601 "creation"
 dateTime.iso8601 "modified"
 string "owner"
 string "group"
 int "permissions"
 string "channel" - Channel name.
 boolean "binary" - Present for files only.
 string "md5" - Present for files only.
 string "macro-start-delimiter" - Present for files only.
 string "macro-end-delimiter" - Present for files only.

Method: deleteChannels

Description:
Delete a list of global config channels. Caller must be a config admin.

Parameters:

string sessionKey
array - Channels to delete.
- string channelLabel

Returns: int - 1 on success.

Method: deleteFiles

Description:
Remove file paths from a global channel.

Parameters:

string sessionKey
string channelLabel - Channel to remove the files from.
array - File paths to remove.
- string path

Returns: int 1 - on success.

Method: getDetails

Description:
Lookup config channel details.

Parameters:

string sessionKey
string channelLabel

Returns: struct (config channel)

 struct (config channel)
  int "id" - Config channel ID.
 string "label" - Config channel label.
 string "name" - Config channel name.
 string "description"
 int "org_id"
 struct (config channel type)
  int "id" 
 string "label"
 string "name"
 int "priority"

Method: getDetails

Description:
Lookup config channel details.

Parameters:

string sessionKey
int channelId

Returns: struct (config channel)

 struct (config channel)
  int "id" - Config channel ID.
 string "label" - Config channel label.
 string "name" - Config channel name.
 string "description"
 int "org_id"
 struct (config channel type)
  int "id" 
 string "label"
 string "name"
 int "priority"

Method: listFiles

Description:
Return a list of files in a channel.

Parameters:

string sessionKey
string channelLabel

Returns: array

 struct (config file)
  string "type" - "file" or "directory".
 string "path" - File path.
 dateTime.iso8601 "modified" - Last modified date.

Method: listGlobals

Description:
List all the global config channels accessible to the logged-in user.

Parameters:

string sessionKey

Returns: array

 struct (config channel)
  int "id" - Config channel ID.
 string "label" - Config channel label.
 string "name" - Config channel name.
 string "description"
 int "org_id"
 struct (config channel type)
  int "id" 
 string "label"
 string "name"
 int "priority"

Method: lookupChannelInfo

Description:
Lists details on a list channels given their channel labels.

Parameters:

string sessionKey
array - Config channel labels.
- string label

Returns: array

 struct (config channel)
  int "id" - Config channel ID.
 string "label" - Config channel label.
 string "name" - Config channel name.
 string "description"
 int "org_id"
 struct (config channel type)
  int "id" 
 string "label"
 string "name"
 int "priority"

Method: lookupFileInfo

Description:
Given a list of paths and a channel, returns details about the latest revisions of the paths.

Parameters:

string sessionKey
string channelLabel
array - List of paths to examine.
- string path

Returns: array

 struct (config revision)
  string "path"
 string "type" - "file" or "directory".
 string "contents"
 string "revision"
 string "created"
 string "modified"
 string "owner"
 string "group"
 string "permissions"
 string "channel" - Channel name.
 boolean "binary" - Present for files only.
 string "md5" - Present for files only.
 string "macro-start-delimiter" - Present for files only.
 string "macro-end-delimiter" - Present for files only.

Method: update

Description:
Update a global config channel. Caller must be at least a config admin or an organization admin, or have access to a system containing this config channel.

Parameters:

string sessionKey
string channelLabel
string channelName
string description

Returns: struct (config channel)

 int "id" - Config channel ID.
 string "label" - Config channel label.
 string "name" - Config channel name.
 string "description"
 int "org_id"
 struct (config channel type)
  int "id" 
 string "label"
 string "name"
 int "priority"