The ATS Reporting Portal CLI is a console application that enables the use of ATS Reporting functionalities from the command line.
The Reporting Portal CLI application consists of a single executable and an appsettings configuration file. Please contact your local ATS representative to obtain these files.
To start using the Reporting Portal CLI application on your Windows machine, you only need to execute this PowerShell script:
# Define the path you want to add to the PATH variable
$deploymentLocation = "C:\Your\Deployment\Path" # Change this to your deployment location on Windows
$currentPath = [Environment]::GetEnvironmentVariable("PATH",
[System.EnvironmentVariableTarget]::Machine)
if ($currentPath -notlike "*$deploymentLocation*") {
$newPath = "$deploymentLocation;$currentPath"
[Environment]::SetEnvironmentVariable("PATH", $newPath,
[System.EnvironmentVariableTarget]::Machine)
}
After executing the script, the Reporting Portal CLI will be available through the Windows Command Prompt.
To start using the Reporting Portal CLI application on a Linux machine, the following bash script should be executed:
#!/bin/bash
# Define the path you want to add to the PATH variable
deploymentLocation="/your/deployment/path" # Change this to your deployment location on Linux
if [[ ":$PATH:" != *":$deploymentLocation:"* ]]; then
export PATH="$deploymentLocation:$PATH"
fi
After executing the script, the Reporting Portal CLI will be available through the Linux Command Prompt.
To list available commands, either run rpcli -? , rpcli -h or execute rpcli --help
|
Usage: |
|
rpcli [command] [options] |
| Options: |
| --version | Show version information. |
| -?, -h, --help | Show help and usage information. |
|
Commands: |
| login | By default, this command logs in with a user account. CLI will try to launch a web browser to log in interactively. |
| logout | Logs out of ATS Security. |
| config | Manage the configuration options, enabling users to get or set the API method path for ATS Security and ATS Reporting Portal. |
| report-source | Manage the ‘report-source’ entity, enabling users to list, add, update and delete. |
| menu | Manage the ‘menu’ entity, enabling users to list, add, update and delete. |
| settings | List and update settings. |
| security-class | Manage the 'security-class' entity, enabling users to list, add, update, and delete. |
| time-period | Manage the 'time-period' entity, enabling users to list, add, update, and delete. |
| schedule | Manage the 'schedule' entity, enabling users to list, add, update, and delete. |
| andon-board | Manage the 'andon-board' entity, enabling users to list, add, update, and delete. |
| andon-report | Manage the 'andon-report' entity, enabling users to list, add, update, and delete. |
By default, this command logs in with a user account. The Reporting Portal CLI will try to launch a web browser to log in interactively.
rpcli login [options]
Login with username and password credentials.
rpcli login -u admin -p Admin2018!
rpcli login -username admin -password Admin2018!
Login with a Personal Access Token.
rpcli -PAT ZjMhJdYyTmYtMzg3OC10ZDAzLzUwZTAtMDhkYjk3TTMxFmRd
rpcli -pat ZjMhJdYyTmYtMzg3OC10ZDAzLzUwZTAtMDhkYjk3TTMxFmRd
|
-u, -username, --u, --username |
A String value that represents the UserName of the account. If the -username option is specified, then the -password option also needs to be specified so that the credentials login flow can be executed. The credentials login flow does not work with accounts created by an External identity provider. |
|
-p, -password, --p, --password |
A String value that represents the Password of the account. If the -password option is specified, then the -username option also needs to be specified so that the credentials login flow can be executed. The credentials login flow does not work with accounts created by an External identity provider. |
|
-PAT, -pat, --PAT, --pat |
A String value that represents the Personal Access Token. Only the -PAT option needs to be specified so that the PAT login flow can be executed. |
Logs out of ATS Security.
rpcli logout
Log out and remove user session.
rpcli logout
Get the API endpoint for ATS Security and ATS Reporting Portal API.
rpcli config get
Get the API endpoint for ATS Security and ATS Reporting Portal API.
rpcli config get
Set the API endpoint for ATS Security and ATS Reporting Portal.
rpcli config set [options]
Set the API endpoint for ATS Security and ATS Reporting Portal.
rpcli config set -s “http://atsdomain:5000” -r “http://atsdomain:4300”
rpcli config set -security “http://atsdomain:5000” -reporting “http://atsdomain:4300”
|
-s, -security, --s, --security |
A String value representing the API method path for the ATS Security API. |
|
-r, --r, -reporting, --reporting |
A String value representing the API method path for the ATS Reporting Portal API. |
List all reporting sources.
rpcli report-source list
List all reporting sources.
rpcli report-source list
Get operations for report-source.
rpcli report-source get [option]
Get report source.
rpcli report-source get -id 10
|
-id, --id (required) |
An Int value that represents the Id of the report source. |
Get reports from source.
rpcli report-source get-reports [option]
Get report source.
rpcli report-source get-reports -id 10
|
-id, --id (required) |
An Int value that represents the Id of the report source. |
Delete operations for report source.
rpcli report-source delete [option]
Delete reporting source.
rpcli report-source delete -id 10
|
-id, --id (required) |
An Int value that represents the Id of the report source. |
Add operations for SSRS type of report source.
rpcli report-source ssrs add [options]
Add SSRS reporting source.
rpcli report-source ssrs add -name InspectSSRS -description CarMakerReports -endpoint http://server.domain/ReportServer -is-inspect true -domain atsvmapeurpt1 -network-user-name admin -network-user-password Admin2018! -date-time-from startDate -date-time-to endDate -timeout 60
rpcli report-source ssrs add -n InspectSSRS -desc CarMakerReports -e http://server.domain/ReportServer -isi true -d atsvmapeurpt1 -nun admin -nup Admin2018! -dtf startDate -dtt endDate -t 60
|
-n, -name <ServerName> (required)
|
A String value that represents the Name of the SSRS reporting source. |
|
-desc, -description, <Description> |
A String value that represents the Description of the SSRS reporting source. |
|
-e, -endpoint <ServerUrlAddress> (required)
|
A String value that represents the Endpoint URL of the SSRS reporting source. |
|
-isi, -is-inspect <IsInspect>
|
A String value that represents the Is Inspect type of report source of the SSRS reporting source. |
|
-d, -domain <Domain>
|
A String value that represents the Domain (not required when using a Service Account) of the SSRS reporting source. |
|
-network-user-name, -nun <Username>
|
A String value that represents the Network User Name (not required when using a Service Account) of the SSRS reporting source. |
|
-network-user-password, -nup <Password>
|
A String value that represents the Network User Password (not required when using Service Account) of the SSRS reporting source. |
|
-date-time-from, -dtf <FromDateParameter>
|
A String value that represents the report's parameter name for the 'from' date-time period filter of the SSRS reporting source. |
|
- -date-time-to, -dtt <ToDateParameter>
|
A String value that represents the report's parameter name for the 'to' date-time period filter of the SSRS reporting source.
|
|
-t, -timeout <Timeout> |
A String value that represents the Timeout of the SSRS reporting source. |
Update operations for SSRS type of report source.
rpcli report-source ssrs update [options]
Update SSRS reporting source.
rpcli report-source ssrs update -id 10 -name InspectSSRS -description CarMakerReports -endpoint http://atsvmapeurpt1.ats-global.local/ReportServer -is-inspect true -domain atsvmapeurpt1 -network-user-name admin -network-user-password Admin2018! -date-time-from startDate -date-time-to endDate -timeout 60
rpcli report-source update-ssrs -id 10 -n InspectSSRS -desc CarMakerReports -e http://server.domain/ReportServer -isi true -d server -nun admin -nup Admin2018! -dtf startDate -dtt endDate -t 60
|
-n, -name <ServerName> (required)
|
A String value that represents the Name of the SSRS reporting source. |
|
-desc, -description <Description> |
A String value that represents the Description of the SSRS reporting source. |
|
-e, -endpoint <ServerUrlAddress> (required)
|
A String value that represents the Endpoint of the SSRS reporting source. |
|
-is-inspect, -isi <IsInspect>
|
A String value that represents the Is Inspect type of report source of the SSRS reporting source. |
|
-d, -domain <Domain> (required)
|
A String value that represents the Domain of the SSRS reporting source. |
|
-network-user-name,
|
A String value that represents the Network User Name of the SSRS reporting source. |
|
-network-user-password, -nup <Password> (required)
|
A String value that represents the Network User Password of the SSRS reporting source. |
|
-date-time-from, -dtf <FromDateParameter>
|
A String value that represents the report's parameter name for the 'from' date-time period filter of the SSRS reporting source. |
|
-date-time-to, -dtt <ToDateParameter> |
A String value that represents the report's parameter name for the 'to' date-time period filter of the SSRS reporting source.
|
|
-t, -timeout <Timeout> |
A String value that represents the Timeout of the SSRS reporting source. |
Get operations for ssrs.
rpcli report-source ssrs get [option]
Get ssrs reporting source.
rpcli report-source ssrs get -id 10
|
-id, --id (required) |
An Int32 value that represents the Id of the 'ssrs'. |
Get reports from source.
rpcli report-source ssrs get-reports [option]
Get ssrs reporting source.
rpcli report-source ssrs get-reports -id 10
|
-id, --id (required) |
An Int32 value that represents the Id of the 'Source'. |
Add CM4D reporting source.
rpcli report-source cm4d add [options]
Add CM4D reporting source.
rpcli report-source cm4d add -name CM4DReport -domain domain -hostname server -network-user-name CM4DService -network-user-password Ados_2022! -database-server-name server -database-name ATS_CM4DSiteDEV06 -database-username UserName -database-password Ados2018!
|
-n, -name <ServerName> (required) |
A String value that represents the Name of the server. |
| -desc, -description <Description> |
A String value that represents the Description of the reporting source. |
| -hn, -hostname <Hostname> (required) | A String value that represents the hostname of the CM4D Scheduler Hostname. |
| -d, -domain <Domain> | A String value that represents the Domain. |
| -network-user-name, -nun <Username> (required) | A String value that represents the Network User Name. |
| -network-user-password, -nup <Password> (required) | A String value that represents the Network User Password. |
| -database-server-name, -dbsn <DatabaseServerName> | A String value that represents the Database Server Name. |
| -database-name, -dbn <DatabaseName> (required) | A String value that represents the Database Name. |
| -database-username, -dbun <UserName> (required) | A String value that represents the Database Username. |
| -database-password, -dbp <Password> (required) | A String value that represents the Database Password. |
| -sample-days-out-number, -sdon <SamplesDaysOutNumber> | A String value that represents the Max Days Out default value. |
| -sample-number, -sn <SamplesNumber> | A String value that represents the Max Sample Count default. |
Update a CM4D reporting source.
rpcli report-source cm4d update [options]
Update a CM4D reporting source.
rpcli report-source cm4d update -id 555 -description UpdatedDescription
| -id <Id> (required) | A String value that represents the Id of the CM4D reporting source. |
|
-n, -name <ServerName> (required) |
A String value that represents the Name of the server. |
| -desc, -description <Description> |
A String value that represents the Description of the reporting source. |
| -hn, -hostname <Hostname> (required) | A String value that represents the hostname of the CM4D Scheduler Hostname. |
| -d, -domain <Domain> | A String value that represents the Domain. |
| -network-user-name, -nun <Username> (required) | A String value that represents the Network User Name. |
| -network-user-password, -nup <Password> (required) | A String value that represents the Network User Password. |
| -database-server-name, -dbsn <DatabaseServerName> | A String value that represents the Database Server Name. |
| -database-name, -dbn <DatabaseName> (required) | A String value that represents the Database Name. |
| -database-username, -dbun <UserName> (required) | A String value that represents the Database Username. |
| -database-password, -dbp <Password> (required) | A String value that represents the Database Password. |
| -sample-days-out-number, -sdon <SamplesDaysOutNumber> | A String value that represents the Max Days Out default value. |
| -sample-number, -sn <SamplesNumber> | A String value that represents the Max Sample Count default. |
Get operations for CM4D.
rpcli report-source cm4d get [option]
Get CM4D reporting source.
rpcli report-source cm4d get -id 10
|
-id, --id (required) |
An Int32 value that represents the Id of the CM4D reporting source. |
Get reports from source.
rpcli report-source cm4d get-reports [option]
Get CM4D reporting source.
rpcli report-source cm4d get-reports -id 10
|
-id, --id (required) |
An Int32 value that represents the Id of the 'Source'. |
Get operations for Inspect CAD reports.
rpcli report-source inspect-cad get [option]
Get Inspect CAD reporting source.
rpcli report-source inspect-cad get -id 10
|
-id, --id (required) |
An Int32 value that represents the Id of the Inspect CAD reporting source. |
Get operations for Power BI.
rpcli report-source power-bi get [option]
Get Power BI reporting source.
rpcli report-source power-bi get -id 10
|
-id, --id (required) |
An Int32 value that represents the Id of the Power BI reporting source. |
Get operations for Tableau.
rpcli report-source tableau get [option]
Get Tableau reporting source.
rpcli report-source Tableau get -id 10
|
-id, --id (required) |
An Int32 value that represents the Id of the Tableau reporting source. |
Get operations for the Web Pages reporting source.
rpcli report-source web-pages get [option]
Get Web Pages reporting source.
rpcli report-source web-pages get -id 10
|
-id, --id (required) |
An Int32 value that represents the Id of the Web Pages reporting source. |
Add Web Pages reporting source.
rpcli report-source web-pages add [option]
Add Web Pages reporting source.
rpcli report-source web-pages add -n TestWebPage1 -desc TestDescription -dtf fromDate -dtt toDate
|
-n, -name <ServerName> (required) |
A String value that represents the Name of the Web Page reporting source. |
| -desc, -description <Description> | A String value that represents the Description of the Web Page reporting source. |
| -date-time-from, -dtf <FromDateParameter> | A String value that represents the report's parameter name for the 'from'date-time period filter of the Web Page reporting source. |
| -date-time-to, -dtt <ToDateParameter> | A String value that represents the report's parameter name for the 'to' date-time period filter of the Web Page reporting source. |
Update Web Pages reporting source.
rpcli report-source web-pages update [option]
Update Web Pages reporting source.
rpcli report-source web-pages update -id 444 -n TestWebPage1 -desc TestDescription -dtf fromDate -dtt toDate
| -id <Id> (required) | A String value that represents the Id of the Web Page reporting source. |
|
-n, -name <ServerName> (required) |
A String value that represents the Name of the Web Page reporting source. |
| -desc, -description <Description> | A String value that represents the Description of the Web Page reporting source. |
| -date-time-from, -dtf <FromDateParameter> | A String value that represents the report's parameter name for the 'from'date-time period filter of the Web Page reporting source. |
| -date-time-to, -dtt <ToDateParameter> | A String value that represents the report's parameter name for the 'to' date-time period filter of the Web Page reporting source. |
Add Web Page report.
rpcli report-source web-pages add-report [options]
Add Web Page report.
rpcli report-source web-pages add-report -source-id 444 -n TestWebPage1 -sp http://www.test.com
|
-source-id <source-id> (required) |
A String value that represents the Id of the Web Page report source. |
| -n, -name <Name> (required) | A String value that represents the Name of the Web Page report. |
| -server-path, -sp <ServerPath> (required) | A String value that represents the ServerPath of the Web Page report. |
Update Web Page report.
rpcli report-source web-pages update-report [options]
Add Web Page report.
rpcli report-source web-pages update-report -source-id 444 -id 789 -n TestWebPageUpdate1
|
-source-id <source-id> (required) |
A String value that represents the Id of the Web Page report source. |
| -id <Id> (required) | A String value that represents the Id of the Web Page report. |
| -n, -name <Name> (required) | A String value that represents the Name of the Web Page report. |
| -server-path, -sp <ServerPath> (required) | A String value that represents the ServerPath of the Web Page report. |
| -?, -h, --help | Show help and usage information. |
Delete Web Page report.
rpcli report-source web-pages delete-report [options]
Delete Web Page report.
rpcli report-source web-pages delete-report -source-id 444 -report-id 789
|
-source-id <source-id> (required) |
A String value that represents the Id of the Web Page report source. |
| -report-id <report-id> (required) | A String value that represents the Id of the Web Page report. |
Add a Web Page report parameter.
rpcli report-source web-pages add-param [options]
Add a Web Page report parameter.
rpcli report-source web-pages add-param -source-id 444 -report-id 789 -name Param1 -pt 6 -upc Code1 -dv TestParam1Value
|
-source-id <source-id> (required) |
A String value that represents the Id of the Web Page report source. |
| -report-id <report-id> (required) | A String value that represents the Id of the Web Page report. |
| -n, -name <Name> (required) | A String value that represents the Name of the Web page report parameter. |
| -param-type, -pt <ParamType> (required) | An Int16 value that represents the Time Span (3-Date/Time, 4-Integer, 5-Float, 6-String, 7-Combo) of the Web Page report. |
| -upc, -url-param-code <UrlParamCode> (required) | A String value that represents the UrlParamCode of the Web Page report parameter. |
| -default-value, -dv <DefaultParamValue> (required) | A String value that represents the Name of the Web page report parameter. |
Update a Web Page report parameter.
rpcli report-source web-pages update-param [options]
Update a Web Page report parameter.
rpcli report-source web-pages update-param -source-id 444 -report-id 789 -id 333 -name Param1Updated
|
-source-id <source-id> (required) |
A String value that represents the Id of the Web Page report source. |
| -report-id <report-id> (required) | A String value that represents the Id of the Web Page report. |
| -id <Id> (required) | A String value that represents the Id of the Web Page report parameter. |
| -n, -name <Name> (required) | A String value that represents the Name of the Web page report parameter. |
| -param-type, -pt <ParamType> (required) | An Int16 value that represents the Time Span (3-Date/Time, 4-Integer, 5-Float, 6-String, 7-Combo) of the Web Page report. |
| -upc, -url-param-code <UrlParamCode> (required) | A String value that represents the UrlParamCode of the Web Page report parameter. |
| -default-value, -dv <DefaultParamValue> (required) | A String value that represents the Name of the Web page report parameter. |
Delete a Web Page report parameter.
rpcli report-source web-pages delete-param [options]
Delete a Web Page report parameter.
rpcli report-source web-pages delete-param -source-id 444 -report-id 789 -param-id 333
|
-source-id <source-id> (required) |
A String value that represents the Id of the Web Page report source. |
| -report-id <report-id> (required) | A String value that represents the Id of the Web Page report. |
| -param-id <param-id> (required) | A String value that represents the Id of the Web Page report parameter. |
Add all reports from a reporting source to a specific menu path.
rpcli menu add-all [options]
Add all reports from a reporting source to a specific menu path.
rpcli menu add-all -rsid 10 -mp folder1/folder2
rpcli menu add-all -report-source-id 10 -menu-path folder1/folder2
|
-rsid, --rsid , -report-source-id , --report-source-id (required)
|
An Int32 value that represents the id of the report source. |
|
-mp, -menu-path, --mp, --menu-path |
A String value that represents the folder path where all the reports will be placed. If the folder path does not exist, the specified folder structure will be created. |
Delete operations for menu items.
rpcli menu delete [option]
Remove all folders and reports that are part of the specified menu path.
rpcli menu delete -p folder1/folder2
rpcli menu delete -path folder1/folder2
|
-p, -path, --p, --path |
A String value that represents the Name of the menu. |
Get operations for settings.
rpcli settings get
Get settings.
rpcli settings get
Set operations for settings.
rpcli settings set [options]
Set SMTP password.
rpcli settings set -sp 4045
|
-sh, -smtp-host <SmtpHost> |
A String value that represents the SMTP host. |
| -smtp-port, -spt <SmtpPort> | An Integer value that represents the SMTP port. |
| -sa, -smtp-authentication | A Boolean value that represents if SMTP authentication is enabled. |
| -smtp-username, -su <SmtpUserName> | A String value that represents the SMTP username used for authentication. |
| -smtp-password, -sp <SmtpPassword> | A String value that represents the SMTP password used for authentication. |
| -se, -sender-email <SenderEmail> | A String value that represents the SMTP email sender. |
| -sender-name, -sn <SenderName> | A String value that represents the SMTP sender name. |
| -enable-ssl, -es | A Boolean value that represents if the SSL option is enabled. |
| -max-number-of-retries, -mnor <MaxNumberOfRetries> | An Integer value that represents the Maximum number of retries. |
| -retention-period, -retp <RetentionPeriod> | An Integer value that represents the Retention period. |
| -hbr, -heartbeat-rate <HeartbeatRate> | An Integer value that represents the Heartbeat rate. |
| -has-password, -hp | A Boolean value that represents if there is already a password. |
Test SMTP Connection.
rpcli settings test-connection [options]
Test connection without changing an option.
rpcli settings test-connection
Test connection after changing an option.
rpcli settings test-connection -sp 4045
|
-sh, -smtp-host <SmtpHost> |
A String value that represents the SMTP host. |
| -smtp-port, -spt <SmtpPort> | An Integer value that represents the SMTP port. |
| -sa, -smtp-authentication | A Boolean value that represents if SMTP authentication is enabled. |
| -smtp-username, -su <SmtpUserName> | A String value that represents the SMTP username used for authentication. |
| -smtp-password, -sp <SmtpPassword> | A String value that represents the SMTP password used for authentication. |
| -se, -sender-email <SenderEmail> | A String value that represents the SMTP email sender. |
| -sender-name, -sn <SenderName> | A String value that represents the SMTP sender name. |
| -enable-ssl, -es | A Boolean value that represents if the SSL option is enabled. |
| -max-number-of-retries, -mnor <MaxNumberOfRetries> | An Integer value that represents the Maximum number of retries. |
| -retention-period, -retp <RetentionPeriod> | An Integer value that represents the Retention period. |
| -hbr, -heartbeat-rate <HeartbeatRate> | An Integer value that represents the Heartbeat rate. |
| -has-password, -hp | A Boolean value that represents if there is already a password. |
List all security classes.
rpcli security-class list
List all security classes.
rpcli security-class list
Get operations for security-class.
rpcli security-class get [option]
Get Security Class.
rpcli security-class get -id 789
|
-id, --id (required) |
A String value that represents the Id of the 'security-class'. |
Add Security Class.
rpcli security-class add [options]
Add Security Class.
rpcli security-class add -n NewSecClass -desc TestDesc
|
-n, -name <Name> (required) |
A String value that represents the Name of the 'security-class'. |
| -desc, -description <Description> | A String value that represents the Description of the 'security-class'. |
Update Security Class.
rpcli security-class update [options]
Add Security Class.
rpcli security-class update -id 77 -n NewSecClassUpdated
|
-id, --id (required) |
A String value that represents the Id of the 'security-class'. |
|
-n, -name <Name> (required) |
A String value that represents the Name of the 'security-class'. |
| -desc, -description <Description> | A String value that represents the Description of the 'security-class'. |
Delete a Security Class.
rpcli security-class delete [option]
Delete a Security Class.
rpcli security-class delete -id 77
|
-id, --id (required) |
A String value that represents the Id of the 'security-class'. |
List all Time Periods.
rpcli time-period list
List all Time Periods.
rpcli time-period list
Get operations for time-period.
rpcli time-period get [option]
Get Time Period.
rpcli time-period get -id 789
|
-id, --id (required) |
A String value that represents the Id of the 'time-period'. |
Add a Time Period.
rpcli time-period add [options]
Add a Time Period.
rpcli time-period add -dn TestTimePeriod -desc TestDescription -tsid 1 -dur 6 -ofs 1
|
--display-name, -dn <DisplayName> |
A String value that represents the DisplayName of the 'time-period'. |
| -desc, -description <Description> | A String value that represents the Description of the 'time-period'. |
| -time-span-id, -tsid <TimeSpanId> (required) | An Int16 value that represents the Time Span (1-Hour, 2-Day, 3-Week, 4-Month, 5-Quarter, 6-Year) of the 'time-period'. |
| -dur, -duration <Duration> (required) | An Int16 value that represents the Duration of the 'time-period'. |
| -offset, -ofs <Offset> (required) | An Int16 value that represents the Offset (0 for Current, -1 for Previous) of the 'time-period'. |
| -sats, -start-at-timespan | A Boolean value that represents the StartAtTimeSpan of the 'time-period'. |
| -week-start-on-id, -wsoid <WeekStartOnId> | An Int16 value that represents the Week starts on Id ( 1-Sunday 2-Monday ) of the 'time-period'. |
Update a Time Period.
rpcli time-period update [options]
Update a Time Period.
rpcli time-period update -id 7 -dn TestTimePeriodUpdated
| -id <Id> (required) | An Int16 value that represents the Id of the 'time-period'. |
|
--display-name, -dn <DisplayName> |
A String value that represents the DisplayName of the 'time-period'. |
| -desc, -description <Description> | A String value that represents the Description of the 'time-period'. |
| -time-span-id, -tsid <TimeSpanId> (required) | An Int16 value that represents the Time Span (1-Hour, 2-Day, 3-Week, 4-Month, 5-Quarter, 6-Year) of the 'time-period'. |
| -dur, -duration <Duration> (required) | An Int16 value that represents the Duration of the 'time-period'. |
| -offset, -ofs <Offset> (required) | An Int16 value that represents the Offset (0 for Current, -1 for Previous) of the 'time-period'. |
| -sats, -start-at-timespan | A Boolean value that represents the StartAtTimeSpan of the 'time-period'. |
| -week-start-on-id, -wsoid <WeekStartOnId> | An Int16 value that represents the Week starts on Id ( 1-Sunday 2-Monday ) of the 'time-period'. |
Delete a Time Period.
rpcli time-period delete [option]
Delete a Time Period.
rpcli time-period delete -id 77
|
-id, --id (required) |
A String value that represents the Id of the 'time-period'. |
List all Schedules.
rpcli schedule list
List all Schedules.
rpcli schedule list
Get operations for schedule.
rpcli schedule get [option]
Get Schedule.
rpcli schedule get -id 789
|
-id, --id (required) |
A String value that represents the Id of the 'schedule'. |
Get export types per report instance id.
rpcli schedule get-export-types [option]
Get export types per report instance.
rpcli schedule get-export-types -id 789
|
-id, --id (required) |
A String value that represents the Id of the 'report instance'. |
Delete a Schedule.
rpcli schedule delete [option]
Delete a Schedule.
rpcli schedule delete -id 77
|
-id, --id (required) |
A String value that represents the Id of the 'schedule'. |
If the selected schedule is Enabled its status changes to Disabled, else it changes to Enabled.
rpcli schedule change-status [option]
Change the status of a schedule.
rpcli schedule change-status -id 789
|
-id, --id (required) |
A String value that represents the Id of the 'schedule'. |
Run schedule.
rpcli schedule run [option]
Run schedule.
rpcli schedule run -id 789
|
-id, --id (required) |
A String value that represents the Id of the 'schedule'. |
List all Andon Boards.
rpcli andon-boards list
List all Andon Boards.
rpcli andon-boards list
Get operations for andon-board.
rpcli andon-board get [option]
Get Andon Board.
rpcli andon-board get -id 789
|
-id, --id (required) |
A String value that represents the Id of the 'andon-board'. |
Add an Andon Board.
rpcli andon-board add [options]
Add an Andon Board.
rpcli andon-board add -n NewAndonBoard
|
-n, -name <Name> (required) |
A String value that represents the Name of the 'andon-board'. |
Delete an Andon Board.
rpcli andon-board delete [option]
Delete an Andon Board.
rpcli andon-board delete -id 77
|
-id, --id (required) |
A String value that represents the Id of the 'andon-board'. |
Get operations for andon-report.
rpcli andon-report get [options]
Get an Andon Report.
rpcli andon-report get -id 44 -andon-board-id 123
|
-id, --id (required) |
An Int16 value that represents the Id of the 'Andon Report'. |
| -andon-board-id <AndonBoardId> (required) | A String value that represents the Id of the 'Andon Board'. |
Can we improve this topic?