home User Guide Getting Started Help Center Documentation Community Training Certification
menu
close
settings
Looker keyboard_arrow_down
language keyboard_arrow_down
English
Français
Deutsch
日本語
search
print
Command : Manage Commands

Create a custom command beta

POST/api/4.0/commands
create_command(body)

Implementation Notes

Create a new command.

Required fields: [:name, :linked_content_id, :linked_content_type]

linked_content_type must be one of [“dashboard”, “lookml_dashboard”]

#

Response Class

Command {
id (long, read-only): Id of the command record,
author_id (long, read-only): Id of the command author,
name (string): Name of the command,
description (string): Description of the command,
linked_content_id (string): Id of the content associated with the command,
linked_content_type (string): Name of the command Valid values are: "dashboard", "lookml_dashboard".
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Writable command parameters body
Command {
id (long, read-only): Id of the command record,
author_id (long, read-only): Id of the command author,
name (string): Name of the command,
description (string): Description of the command,
linked_content_id (string): Id of the content associated with the command,
linked_content_type (string): Name of the command Valid values are: "dashboard", "lookml_dashboard".
}

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
409 Resource Already Exists
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get All Commands beta

GET/api/4.0/commands
get_all_commands(content_id, content_type, limit)

Implementation Notes

Get All Commands.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
content_id false Id of the associated content. This must be accompanied with content_type. string string
content_type false Type of the associated content. This must be accompanied with content_id. string string
limit false Number of results to return. integer int64

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
405 Resource Can’t Be Modified
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Update a custom command beta

PATCH/api/4.0/commands/{command_id}
update_command(command_id, body)

Implementation Notes

Update an existing custom command.

Optional fields: [‘name’, ‘description’]

#

Response Class

Command {
id (long, read-only): Id of the command record,
author_id (long, read-only): Id of the command author,
name (string): Name of the command,
description (string): Description of the command,
linked_content_id (string): Id of the content associated with the command,
linked_content_type (string): Name of the command Valid values are: "dashboard", "lookml_dashboard".
}

Parameters

Parameter Required? Description Parameter Type Data Type
command_id true ID of a command integer int64
body true Re-writable command parameters body
UpdateCommand {
name (string): Name of the command,
description (string): Description of the command
}

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Delete a custom command beta

DELETE/api/4.0/commands/{command_id}
delete_command(command_id)

Implementation Notes

Delete an existing custom command.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
command_id true ID of a command integer int64

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
405 Resource Can’t Be Modified
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
204 The command is deleted.
Top