Availability

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Release 6.3.0-SNAPSHOT
Div
idProductTOC

On this page

P
Table of Contents
maxLevel1
typeflat
separatorpipe

Related information for 6.3.0-SNAPSHOT

Actions

Div

Action

Category

Description

Required parameters

Optional parameters

Output formats

1

addRoomMembers

Anchor
addRoomMembers
addRoomMembers

Rooms

Add one or more members to a room.

room, name

 

 

2

createRoom

Anchor
createRoom
createRoom

Rooms

Create a new room.

room

topic, owner, access, guestAccess

 

3

createUser

Anchor
createUser
createUser

Users

Create a user. If a password is not provided, a random password will be used and the user will need to use the 'Forgot your password?' link.

name, email

title, userPassword, mentionName, timeZone, isAdmin

 

4

deleteRoom

Anchor
deleteRoom
deleteRoom

Rooms

Delete a room by name or id.

room

 

 

5

deleteUserPhoto

Anchor
deleteUserPhoto
deleteUserPhoto

Users

Delete a user's photo.

mentionName or email or name

 

 

6

deleteUser

Anchor
deleteUser
deleteUser

Users

Delete a user by name or id. User can also be identified by email or mentionName.

mentionName or email or name

 

 

7

getClientInfo

Anchor
getClientInfo
getClientInfo

Info

Get information about the this client tool.

 

outputFormat, file, append, encoding

1 - basic
2 - JVM

8

getEmoticonList

Anchor
getEmoticonList
getEmoticonList

Emoticons

Get a list of emoticons matching regex filtering on emoticon name.

 

type, regex, limit, file, encoding

1 - basic
2 - detail

9

getEmoticon

Anchor
getEmoticon
getEmoticon

Emoticons

Get information about an emoticon by name or id.

name

regex, file, encoding

 

10

getRoomHistoryList

Anchor
getRoomHistoryList
getRoomHistoryList

Rooms

Get a list of messages for a room matching regex filtering base on message text. By default, the most recent 75 entries are returned unless dates are provided or limit is explicitly set. Selection considers most recent entries first. Default order descending by date (most recent first). Date filtering is available by start and/or end dates specified in the dateFormat or some special values like 'today', -1d, -10h. See the documentation for more details.

room

startDate, endDate, accending, regex, dateFormat, limit, file, encoding, append

 

11

getRoomList

Anchor
getRoomList
getRoomList

Rooms

Get a list of room matching regex filtering on room name and other selection criteria.

 

regex, includePrivate, includeArchived, limit, file, encoding, append

1 - basic
999 - all

12

getRoomMemberList

Anchor
getRoomMemberList
getRoomMemberList

Rooms

Get a list of members for a room matching regex filtering on user name or mention name.

room

regex, limit, file, encoding, append

 

13

getRoomParticipantList

Anchor
getRoomParticipantList
getRoomParticipantList

Rooms

Get a list of participants for a room matching regex filtering on user name or mention name.

room

includeOffline, regex, limit, file, encoding, append

 

14

getRoom

Anchor
getRoom
getRoom

Rooms

Get room information by name or id.

room

file, encoding

 

15

getServerInfo

Anchor
getServerInfo
getServerInfo

Info

Get information about the HipChat server.

 

dateFormat, file, append, encoding

1 - basic
2 - detail

16

getUserHistoryList

Anchor
getUserHistoryList
getUserHistoryList

Users

Get a list of recent messages (maximum 75) for a user matching regex filtering based on message text. Selection considers most recent entries first. Default order descending by date (most recent first).

name

accending, regex, dateFormat, limit, file, encoding, append

 

17

getUserList

Anchor
getUserList
getUserList

Users

Get a list of users matching regex filtering criteria on user name or mention name.

 

limit, regex, includeGuests, includeDeleted, file, encoding, append

 

18

getUser

Anchor
getUser
getUser

Users

Get user information.

mentionName or email or name

file, encoding

 

19

inviteUserToGroup

Anchor
inviteUserToGroup
inviteUserToGroup

Users

Invite a user to join the group by the email address. Supply a unique name that the user will be known as within the group. HipChat sends an email to the user.

email, name

title, timeZone

 

20

inviteUsers

Anchor
inviteUsers
inviteUsers

Users

Invite one more more users to a room. A reason message (limit 250 characters) can be included

room, name

message

 

21

removeRoomMembers

Anchor
removeRoomMembers
removeRoomMembers

Rooms

Remove one or more members to a room.

room, name

 

 

22

renderRequest

Anchor
renderRequest
renderRequest

Render

Render url based request. The response data modified by findReplace processing is returned.

request

requestParameters, file, encoding, findReplace, findReplaceRegex

 

23

runFromCsv

Anchor
runFromCsv
runFromCsv

CSV

Run actions generated from a CSV file.

file

common, propertyFile, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

24

runFromList

Anchor
runFromList
runFromList

Run

Run actions for each entry in a list. When file is provided, each action in the file augmented by the common parameter will be run for each entry. Otherwise, just the action specified by the common parameter will be run. Available replacement variables are entry, entry2.

list

list2, file, common, continue, quiet, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

25

runFromRoomList

Anchor
runFromRoomList
runFromRoomList

Rooms

Run an action for each room matching regex filtering on room name and other selection criteria.

 

regex, includePrivate, includeArchived, limit, common, continue, simulate, clearFileBeforeAppend, findReplace, findReplaceRegex, file, encoding

 

26

runFromSql

Anchor
runFromSql
runFromSql

Run

Run actions generated by SQL provided by the sql parameter, a file, or standard input

sql or file or standard input

common, driver, database, host, port, url, dbUser, dbPassword, propertyFile, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

27

run

Anchor
run
run

Run

Run actions from a file or standard input.

file or standard input

common, continue, simulate, clearFileBeforeAppend, encoding, findReplace, findReplaceRegex

 

28

sendMessage

Anchor
sendMessage
sendMessage

Messages

Send message to a room by name or id. File contents are appended to the message. Messages are limited to 1000 characters - longer messages will be automatically sent as a file.

room, message or file

autoSplit, encoding

 

29

sendMessagesFromFile

Anchor
sendMessagesFromFile
sendMessagesFromFile

Messages

Send message to a room for each line of a file that matches the regex parameters. When regex filtering is used, the replace parameter can optionally be used to modify the line based on capture groups before being sent. By default the entire file is processed and then the action ends. If a positive timeout values is provided, processing will wait and process newly appended lines until the timeout period has been exceeded. If timeout is set to -1, processing continues until the command processor is forced to end.

room, file

regex, replace, timeout, blockStartRegex, excludeRegex, autoSplit, encoding

 

30

sendNotification

Anchor
sendNotification
sendNotification

Notifications

Send notification to a room by name or id. File contents are appended to the message. Messages are limited to 10000 characters - longer messages will be automatically sent as a file.

room, message or file

messageFormat, color, notify, encoding

 

31

sendNotificationsFromFile

Anchor
sendNotificationsFromFile
sendNotificationsFromFile

Notifications

Send notification to a room for each line of a file that matches the regex parameters. When regex filtering is used, the replace parameter can optionally be used to modify the line based on capture groups before being sent. By default the entire file is processed and then the action ends. If a positive timeout values is provided, processing will wait and process newly appended lines until the timeout period has been exceeded. If timeout is set to -1, processing continues until the command processor is forced to end.

room, file

regex, replace, messageFormat, color, notify, timeout, blockStartRegex, excludeRegex, encoding

 

32

sendPrivateMessage

Anchor
sendPrivateMessage
sendPrivateMessage

Messages

Send message to a specific user by name. File contents are appended to the message. Messages are limited to 10000 characters - longer messages will be automatically sent as a file.

mentionName or email or name, message or file

messageFormat, notify, encoding

 

33

sendPrivateMessagesFromFile

Anchor
sendPrivateMessagesFromFile
sendPrivateMessagesFromFile

Messages

Send message to a user for each line of a file that matches the regex parameters. When regex filtering is used, the replace parameter can optionally be used to modify the line based on capture groups before being sent. By default the entire file is processed and then the action ends. If a positive timeout values is provided, processing will wait and process newly appended lines until the timeout period has been exceeded. If timeout is set to -1, processing continues until the command processor is forced to end.

name, file

regex, replace, messageFormat, timeout, blockStartRegex, excludeRegex, encoding

 

34

shareFileWithUser

Anchor
shareFileWithUser
shareFileWithUser

Messages

Share a file with a user.

mentionName or email or name, file

message, fileName

 

35

shareFile

Anchor
shareFile
shareFile

Messages

Share a file with a room.

room, file

message, fileName

 

36

shareLinkWithUser

Anchor
shareLinkWithUser
shareLinkWithUser

Messages

Share a link with a user.

mentionName or email or name, link

message

 

37

shareLink

Anchor
shareLink
shareLink

Messages

Share a link with a room.

room, link

message

 

38

updateRoom

Anchor
updateRoom
updateRoom

Rooms

Update an existing room.

room

name, topic, owner, access, guestAccess, disableGuestAccess, archive, unarchive

 

39

updateUserPhoto

Anchor
updateUserPhoto
updateUserPhoto

Users

Update user photo. File should be a recognized image file with proper extension like: png, jpeg

mentionName or email or name, file

 

 

40

updateUser

Anchor
updateUser
updateUser

Users

Updates information for an existing user. Guest users cannot be udpated.

mentionName or email or name

newName, newEmail, newMentionName, title, userPassword, timeZone, isAdmin, isNotAdmin

 

Parameter Tips

Include Page
ACLI:Shared - tips for documentation
ACLI:Shared - tips for documentation

Parameters

Div

Parameter

Short

Value

Description

1

accending

Anchor
accending
accending

 

(error)

Order history in date accending order (earliest first).

2

access

Anchor
access
access

 

(tick)

Room access setting. Valid values are: public, private (default: public)

3

action

Anchor
action
action

a

(tick)

 

4

afterSql

Anchor
afterSql
afterSql

 

(tick)

SQL to run after a successful action. Limited to specific actions at this time.

5

append

Anchor
append
append

 

(error)

For some actions using the file parameter, append will append output to the existing file.

6

archive

Anchor
archive
archive

 

(error)

Archive the room.

7

autoSplit

Anchor
autoSplit
autoSplit

 

(error)

Automatically attempt to split messages that exceed HipChat's maximum message length. Messages with lines within the length limit qualify for auto splitting.

8

autoWait

Anchor
autoWait
autoWait

 

(error)

HipChat limits the rate of requests it will handle in a period of time. Use this switch to automatically handle rate limit failures and retry. The action may take a few minutes to complete. Do not use this switch in performance critical contexts like JIRA post functions or Confluence renderings.

9

blockStartRegex

Anchor
blockStartRegex
blockStartRegex

 

(tick)

Regular expression for determining the start of a block of lines for sendMessagesFromFile. A line matching this regex will indicate the end of a previous block and the start of a new block of lines. A special value of @log will provide standard handling of Atlassian default style log files including exceptions.

10

clearFileBeforeAppend

Anchor
clearFileBeforeAppend
clearFileBeforeAppend

 

(error)

For run actions, this option will automatically clear an existing file on the first append requested.

11

color

Anchor
color
color

 

(tick)

Background color of a message. Default is yellow.

12

colour

Anchor
colour
colour

 

(tick)

Background colour of a message. Default is yellow.

13

columns

Anchor
columns
columns

 

(tick)

Column selection and ordering when action generates CSV output. A comma separated list of column numbers (1-based) or column names (case insensitive). Only columns provided by the selected outputFormat are available for selection. Invalid columns will be ignored.

14

comment

Anchor
comment
comment

 

(tick)

Comment text.

15

common

Anchor
common
common

 

(tick)

Common parameter string added to all run actions.

16

connectionTimeout

Anchor
connectionTimeout
connectionTimeout

 

(tick)

Allow overriding environment settings for connect and read timeouts on URL connections. In milliseconds, 0 means infinite.

17

continue

Anchor
continue
continue

 

(error)

Continue processing even after errors are encountered for run actions. Also used for some action to ignore certain errors like not found errors on remove actions.

18

cookies

Anchor
cookies
cookies

 

(tick)

Name of file to restore and persist cookies across invocations of CLI actions. Can be used to provide Data Center session affinity for actions using REST APIs.

19

database

Anchor
database
database

 

(tick)

Database name is required for SQL actions.

20

dateFormat

Anchor
dateFormat
dateFormat

 

(tick)

Format string for dates in Java SimpleDateFormat. Default for output is client date format. Default for date parsing is lenient starting with client date format and then some other standard formats based on JSON date format.

21

dateFormat2

Anchor
dateFormat2
dateFormat2

 

(tick)

Alternate format string for dates in Java SimpleDateFormat. Use specific (may be ignored), but normally used for date only fields to avoid longer dateFormat based output. Some uses default to yyyy-MM-dd.

22

dbCreateTable

Anchor
dbCreateTable
dbCreateTable

 

(error)

Database table needs to be created before adding rows.

23

dbJar

Anchor
dbJar
dbJar

 

(tick)

By default, lib/jdbc is used to automatically load database drivers. Otherwise you can specify a specific file or url reference for the database driver jar. Example /jdbcDrivers/postgresql-9.3-1102.jdbc41.jar or

https://jdbc.postgresql.org/download/postgresql-9.3-1102.jdbc41.jar

24

dbPassword

Anchor
dbPassword
dbPassword

 

(tick)

Database user password. Defaults to password.

25

dbTable

Anchor
dbTable
dbTable

 

(tick)

Database table name when creating or updating a database from list output.

26

dbTableKeys

Anchor
dbTableKeys
dbTableKeys

 

(tick)

Comma separated list of column names used to access existing rows for update. Normally this defines a primary key set for the table.

27

dbUser

Anchor
dbUser
dbUser

 

(tick)

Database user name. Defaults to user.

28

debug

Anchor
debug
debug

 

(error)

Requests detail debug output. Optional for all actions.

29

disableGuestAccess

Anchor
disableGuestAccess
disableGuestAccess

 

(error)

Disallow access to the room by non-users.

30

driver

Anchor
driver
driver

 

(tick)

JDBC driver class or predefined value: postgresql, mysql, mssql, oracle, or db2400. Required for SQL actions.

31

email

Anchor
email
email

 

(tick)

User email. Email can be used to uniquely identify a user.

32

encoding

Anchor
encoding
encoding

 

(tick)

Character encoding (character set) for text based file content - must be an encoding supported by your JAVA platform.

33

endDate

Anchor
endDate
endDate

 

(tick)

Latest date for history entries. Default to now.

34

excludeRegex

Anchor
excludeRegex
excludeRegex

 

(tick)

Regular expression for determining if a individual line should be excluded when using sendMessagesFromFile. This excludes any matching line from being sent whether it is part of a block or not. It has no impact on block determination, other block lines will not be excluded. Exclude takes precendence over include filtering.

35

file

Anchor
file
file

f

(tick)

Path to file based content or result output. Use - for standard input.

36

fileName

Anchor
fileName
fileName

 

(tick)

Name of file when shared. Defaults to the name of the file represented by the file parameter.

37

findReplace

Anchor
findReplace
findReplace

 

(tick)

Find and replace text. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be escaped.

38

findReplaceRegex

Anchor
findReplaceRegex
findReplaceRegex

 

(tick)

Find and replace text with a regular expression. Comma separated list of colon separated pairs. Single quote values containing a delimiter. Embedded quotes must be doubled.

39

guestAccess

Anchor
guestAccess
guestAccess

 

(error)

Allow access to the room by non-users via a guest URL.

40

help

Anchor
help
help

 

(error)

Prints this help message.

41

host

Anchor
host
host

 

(tick)

Database host server for SQL actions. Not used if url is provided. Defaults to localhost if not provided.

42

includeArchived

Anchor
includeArchived
includeArchived

 

(error)

Include archived rooms in the list.

43

includeDeleted

Anchor
includeDeleted
includeDeleted

 

(error)

Include deleted users in the list.

44

includeGuests

Anchor
includeGuests
includeGuests

 

(error)

Include guests in the list.

45

includeOffline

Anchor
includeOffline
includeOffline

 

(error)

Include users with offline status in the list.

46

includePrivate

Anchor
includePrivate
includePrivate

 

(error)

Include private rooms in the list.

47

isAdmin

Anchor
isAdmin
isAdmin

 

(error)

Set user to be an administrator.

48

isNotAdmin

Anchor
isNotAdmin
isNotAdmin

 

(error)

Set user to not be an administrator. Default for created users.

49

limit

Anchor
limit
limit

 

(tick)

Maximum number of entries to return. (default: 2147483647)

50

link

Anchor
link
link

 

(tick)

An absolute link to share.

51

list

Anchor
list
list

 

(tick)

Comma separated list of entries to populate the entry replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.

52

list2

Anchor
list2
list2

 

(tick)

Comma separated list of entries to populate the entry2 replacement variable on runFromList. Single quote values containing a delimiter. Embedded quotes must be doubled.

53

mentionName

Anchor
mentionName
mentionName

 

(tick)

Mention name for a user.

54

message

Anchor
message
message

 

(tick)

A text (default) or html message. Message length is limited to 10000 characters.

55

messageFormat

Anchor
messageFormat
messageFormat

 

(tick)

Format of the message. Valid values are: text, html. Default is text.

56

mimeType

Anchor
mimeType
mimeType

 

(tick)

File mime type if you want to override automatic determination by file extension.

57

name

Anchor
name
name

 

(tick)

Entity name. In most cases, an entity's numeric id can be a substitute for a name. Example: user, room, or emoticon name. Room and user names are restricted to 50 characters or less.

58

newEmail

Anchor
newEmail
newEmail

 

(tick)

New email address for updating a user.

59

newMentionName

Anchor
newMentionName
newMentionName

 

(tick)

New mention name for updating a user.

60

newName

Anchor
newName
newName

 

(tick)

New entity name for an update.

61

notify

Anchor
notify
notify

 

(error)

Whether a message should trigger a user notification respecting recipient's notification preferences.

62

options

Anchor
options
options

 

(tick)

Comma separated list of support, experimental, or other client or action specific options.

63

outputFormat

Anchor
outputFormat
outputFormat

 

(tick)

Specify output format for an action. (default: 1)

64

owner

Anchor
owner
owner

 

(tick)

Room owner by name or id.

65

port

Anchor
port
port

 

(tick)

Database host port for SQL actions. Optional, defaults to database default. Not used if url is provided.

66

propertyFile

Anchor
propertyFile
propertyFile

 

(tick)

Property file with database parameters, field mappings, or client specific information.

67

quiet

Anchor
quiet
quiet

 

(error)

Limit some output messages. Optional for all actions.

68

reference

Anchor
reference
reference

 

(tick)

Reference to a replacement key value used to remember an action specific value like issue key or similar so it can be referenced later.Each action that allows this parameter will specify what value is being set for the reference replacement key.

69

regex

Anchor
regex
regex

 

(tick)

Regular expression for including matching content. For example, used to subset lists of rooms.

70

replace

Anchor
replace
replace

 

(error)

Replace existing entity on add, create, or similar actions.

71

replacement

Anchor
replacement
replacement

 

(tick)

Replacement string when matching content with a regular expression. Use $1 and similar for capture groups.

72

request

Anchor
request
request

 

(tick)

URL fragment for a request.

73

requestParameters

Anchor
requestParameters
requestParameters

 

(tick)

URL request parameters or post data.

74

room

Anchor
room
room

 

(tick)

Room name or id.

75

server

Anchor
server
server

s

(tick)

Server URL. Normally the base URL of the server and the same as how the server is accessed from a browser.

76

simulate

Anchor
simulate
simulate

 

(error)

Simulate running actions. Log the action that would be taken.

77

special

Anchor
special
special

 

(tick)

Ordered list of alternate characters for comma ( , ), colon ( : ), at ( @ ), quote ( ' ), and double quote ( " ) characters used for specialized processing of some specific parameters.

78

sql

Anchor
sql
sql

 

(tick)

SQL select statement used to generate a run script.

79

startDate

Anchor
startDate
startDate

 

(tick)

Earliest date to get history data. Default is recent to get the most recent 75 entries.

80

timeZone

Anchor
timeZone
timeZone

 

(tick)

User timeZone. See

https://bobswift.atlassian.net/wiki/x/noIbBg

.

81

timeout

Anchor
timeout
timeout

 

(tick)

Seconds to wait looking for lines to be appended to a file. Use -1 for infinite wait. (default: 0)

82

title

Anchor
title
title

 

(tick)

Job title for a user.

83

token

Anchor
token
token

t

(tick)

Authentication token for remote access. Obtain the 40 character token by logging in to HipChat and going to 'Account Settings' then 'API access'.

84

topic

Anchor
topic
topic

 

(tick)

Room topic.

85

type

Anchor
type
type

 

(tick)

Emoticon type. Valid values are: all, global, group. Default is all.

86

unarchive

Anchor
unarchive
unarchive

 

(error)

Unarchive the room.

87

url

Anchor
url
url

 

(tick)

Action specific setting. Example: Database access url for SQL actions. Optional when host is provided.

88

userPassword

Anchor
userPassword
userPassword

 

(tick)

User password for user management actions.

89

verbose

Anchor
verbose
verbose

v

(error)

Requests verbose output to help with problem determination. Optional for all actions.