Domo Component
The Domo platform includes a world class data warehouse, robust data pipeline functionality, and visualization engine.
Component key: domo
Description
Domo provides a large suite of enterprise-grade tools thaat help organizations unlock business value from their data. The Domo platform includes a world class data warehouse, robust data pipeline functionality, and an industry-leading visualization engine — all while ensuring data is well-governed and secure.
Connections
Domo OAuth Connection
Generating Client ID and Client Secret
To generate a client ID and client secret for your Domo instance, follow these steps:
-
Obtain your Domo Instance Name:
- Your Domo Instance Name is the part of the URL preceding "domo.com." For instance, if your Domo URL is "acmecompany.domo.com," your instance name would be "acmecompany."
-
Log in to the Developer Portal:
- Click on the "Dev Portal Login" link to access the Developer Portal or follow this link https://developer.domo.com/login.
-
Enter Instance Name and User Credentials:
- Provide your Domo Instance Name and user credentials when prompted to log in.
-
Access "Manage Clients" Page:
- After logging in successfully, you will be redirected to the Developer Portal's homepage.
- Click on the "My Account" dropdown, and you will find options to manage clients, create a new one, or logout.
-
Create a New Client:
- Choose the option to create a new client from the "Manage Clients" page.
-
Submit and Obtain Client ID and Secret:
- After submitting the required information, a newly provisioned client ID and client secret will be generated and displayed on the "Manage Clients" page.
Now you have successfully generated a client ID and client secret for your Domo instance. These credentials will be used in the component's OAuth connection.
| Input | Notes | Example |
|---|---|---|
Client ID string / Required clientId | Client Identifier of your Domo app for the API | |
Client Secret password / Required clientSecret | Client Secret of your Domo app for the API | |
Scopes string / Required scopes | Space separated OAuth permission scopes for the API | data workflow audit buzz user account dashboard |
Data Sources
Select Account
Select a Domo account. | key: accounts | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The number of Accounts to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of Accounts to begin the list of Accounts within the response. |
Select Account Type
Select a Domo account type. | key: accountTypes | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The number of Account Types to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the Account Types to begin list of Account Types within the response. |
Select Group
Select a Domo group. | key: groups | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The amount of groups to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the group ID to begin list of groups within the response. |
Select Page
Select a Domo page. | key: pages | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The amount of pages to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the page ID to begin list of pages within the response. |
Select Project
Select a Domo project. | key: projects | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection |
Select Project List
Select a Domo project list. | key: projectLists | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Project ID string / Required projectId | The ID of the project. |
Select Stream
Select a Domo stream. | key: streams | type: picklist
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The amount of Stream to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the Stream ID to begin list of users within the response. |
Actions
Abort Stream Execution
If needed during an execution, aborts an entire Stream execution. | key: abortStreamExecution
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Execution ID string / Required executionId | The ID of the Stream execution within the Stream, if no Stream execution ID is provided, the current Stream execution will be aborted. |
Stream ID string / Required streamId | The ID of the Stream of data being imported into a DataSet. |
Add Attachment
Add a multipart form file to a task item as an attachment. | key: addAttachment
| Input | Notes |
|---|---|
Connection connection / Required connection | |
List ID string / Required listId | The ID of the list. |
Project ID string / Required projectId | The ID of the project. |
Task ID string / Required taskId | The ID of the task. |
Add User To Group
Add user to a group in your Domo instance. | key: addUserToGroup
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Group ID string / Required groupId | The ID of the group. |
User ID string / Required userId | The ID of the user. |
Commit Stream Execution
Commits stream execution to import combined set of data parts that have been successfully uploaded. | key: commitStreamExecution
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Execution ID string / Required executionId | The ID of the Stream execution within the Stream |
Stream ID string / Required streamId | The ID of the Stream of data being imported into a DataSet. |
Create Account
When creating an Account, you must specify the Account Type properties. The Account Type properties are different, depending on the type of Account you are trying to create. | key: createAccount
| Input | Notes |
|---|---|
Authenticate By string authenticateBy | |
Connection connection / Required connection | |
ID string id | |
Name string name | |
Password string password | |
URL string url | |
Username string username |
Create Data Set
Creates a new DataSet in your Domo instance. Once the DataSet has been created, data can then be imported into the DataSet. | key: createDataSet
| Input | Notes | Example |
|---|---|---|
Columns code / Required columns | Array of columns in the DataSet | |
Connection connection / Required connection | ||
Description string / Required description | Description of the DataSet to create | |
Name string / Required name | Name of the DataSet to create | |
Rows string rows |
Create Group
Creates a new group in your Domo instance. | key: createGroup
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Name string / Required name | The name of the group. |
Create List
Creates a new list within the given project id. | key: createList
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Index string index | The ordered index of the list within the project. Setting this property will re-order other lists in the project to maintain sequential order. Leaving this property blank will default the index to 1 and shift the index of all other lists. |
Name string / Required name | The name of the list. |
Project ID string / Required projectId | The ID of the project. |
Type string / Required type | The type of the list. |
Create Page
Creates a new page in your Domo instance. | key: createPage
| Input | Notes |
|---|---|
Card ID string Value List cardIds | The ID of the card to add to the page |
Connection connection / Required connection | |
Group ID string Value List groupIds | The ID of the group that will be given access to view the page |
Locked string locked | will restrict other users the ability to make edits to page or its content - the default value is false |
Name string name | The name of the page. |
Parent ID string parentId | If provided, the page will be created as a subpage to the page provided |
User ID string Value List userIds | The ID of the user that will be given access to view the page |
Create Project
Create a new project in your Domo instance | key: createProject
| Input | Default | Notes |
|---|---|---|
Name string bodyName | Body name | |
Connection connection / Required connection | ||
Description string description | The description of the project. | |
Due Date string dueDate | The due date of the project | |
Members string / Required members | Array of user ID's that will be assigned as members of the project | |
Member ID string Value List membersArray | Body member | |
Name string / Required name | The name of the project. | |
Public Body string publicBody | ||
Public string / Required publicInput | true | Whether or not the project should be publicly available to other Domo users |
Create Stream
When creating a Stream, specify the DataSet properties (name and description) and as a convenience, the create Stream API will create a DataSet for you. | key: createStream
| Input | Notes | Example |
|---|---|---|
Columns code columns | ||
Connection connection / Required connection | ||
DataSet object string / Required Value List dataSet | The DataSet object associated with this Stream. | |
Description string description | ||
Name string name | ||
Update Method string updateMethod | The data import behavior. | |
Update Method string updateMethodBody | Update method for body. |
Create Stream Execution
When you’re ready to upload data to your DataSet via a Stream, you first tell Domo that you’re ready to start sending data by creating an Execution. | key: createStreamExecution
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Stream ID string / Required streamId | The ID of the Stream. |
Create Task
Add a task to a project list. | key: createTask
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Contributors string contributors | An array of user IDs that are assigned as contributors to the task. | |
Description string description | An optional description of the task. | |
Due Date string dueDate | The date the task is expected to be completed. | |
List ID string / Required listId | The ID of the list within a project that the task belongs to. | |
Owned By string ownedBy | The ID of the Domo user that owns the task. | |
Priority string priority | Priority of task within a list. Setting this property will impact the index of other tasks in the list to maintain sequential order. If not provided the priority will default to 1 and the index of all the other tasks in the list will shift. | |
Project ID string / Required projectId | The ID of the project that the task belongs to. | |
Tags string tags | An array of tags that have been assigned to the task. | |
Task Name string / Required taskName | The name of the task. | |
Task Object code taskObjectBody | The request body accepts a task object. |
Create User
Creates a new user in your Domo instance. | key: createUser
| Input | Default | Notes | Example |
|---|---|---|---|
Alternate Email string alternateEmail | User's secondary email in profile. | ||
Connection connection / Required connection | |||
Email string / Required email | User's primary email used in profile. | ||
Employee Number string employeeNumber | Employee number within company. | ||
Locale string locale | Locale used to display to user the system settings throughout Domo application. | ||
Location string location | Free text that can be used to define office location. | ||
Name string name | |||
Phone string phone | Primary phone number of user. | ||
Role string / Required role | Admin | The role of the user created. | |
Send Invite string sendInvite | Send an email invite to created user. | ||
Timezone string timezone | Time zone used to display to user the system times throughout Domo application. | ||
Title string title | User's job title. | ||
User Body code userBody |
Delete Account
Deletes an Account from your Domo instance. | key: deleteAccount
| Input | Notes |
|---|---|
Account ID string / Required accountId | The ID of the account to delete. |
Connection connection / Required connection |
Delete Attachment
Permanently deletes an attachment from your task. | key: deleteAttachment
| Input | Notes |
|---|---|
Attachment ID string / Required attachmentId | The ID of the attachment. |
Connection connection / Required connection | |
Project ID string / Required projectId | The ID of the project that the attachment belongs to. |
Task ID string / Required taskId | The ID of the task that the attachment belongs to. |
Delete Data Set
Permanently deletes a DataSet from your Domo instance. This can be done for all DataSets, not just those created through the API. | key: deleteDataSet
| Input | Notes |
|---|---|
Connection connection / Required connection | |
DataSet ID string / Required datasetId | The ID of the DataSet. |
Delete Group
Permanently deletes a group from your Domo instance. | key: deleteGroup
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Group ID string / Required groupId | The ID of the group to delete. |
Delete List
Permanently deletes a list from your Domo instance. | key: deleteList
| Input | Notes |
|---|---|
Connection connection / Required connection | |
List ID string / Required listId | The ID of the list. |
Project ID string / Required projectId | The ID of the project. |
Delete Page
Permanently deletes a page from your Domo instance. | key: deletePage
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Page ID string / Required pageId | The ID of the page. |
Delete Project
Permanently deletes a project from your Domo instance. | key: deleteProject
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Project ID string / Required projectId | The ID of the project. |
Delete Stream
Deletes a Stream from your Domo instance. This does not a delete the associated DataSet. | key: deleteStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Stream ID string / Required streamId | The ID of the Stream to delete. |
Delete User
Permanently deletes a user from your Domo instance. | key: deleteUser
| Input | Notes |
|---|---|
Connection connection / Required connection | |
User ID string / Required userId | The ID of the user. |
Download Attachment
Downloads an individual attachment given an attachment id. | key: downloadAttachment
| Input | Notes |
|---|---|
Attachment ID string / Required attachmentId | The ID of the attachment. |
Connection connection / Required connection | |
List ID string / Required listId | The ID of the list. |
Project ID string / Required projectId | The ID of the project. |
Task ID string / Required taskId | The ID of the task. |
Export Data From DataSet
Export data from a DataSet in your Domo instance. | key: exportDataFromDataSet
| Input | Notes |
|---|---|
Connection connection / Required connection | |
File Name string fileName | The filename of the exported csv. |
Include Header string includeHeader | Include table header. |
Get Accounts
Retrieve the details of an account type. This includes information on the properties required to create an Account of this type. | key: getAccounts
| Input | Notes |
|---|---|
Account Type ID string / Required accountTypeId | The ID of the account type. |
Connection connection / Required connection |
Get Activity Log Entries
Retrieves activity log entries | key: getActivityLogEntries
| Input | Notes |
|---|---|
Connection connection / Required connection | |
End string end | The end time(milliseconds) of when you want to receive log events. |
Limit string limit | The maximum number of events you want to retrieve(default is 50, maximum of 1000). |
Offset string offset | The offset location of events you retrieve(default is 0). |
Start string / Required start | The start time(milliseconds) of when you want to receive log events. |
User string user | The Id of the user. |
Get Data Set
Retrieves the details of an existing DataSet. | key: getDataSet
| Input | Notes |
|---|---|
Connection connection / Required connection | |
DataSet ID string / Required datasetId | The ID of the DataSet. |
Get Group
Retrieves the details of an existing group. | key: getGroup
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Group ID string / Required groupId | The ID of the group. |
Get List
Retrieves the details of an individual list given a project id and a list id. | key: getList
| Input | Notes |
|---|---|
Connection connection / Required connection | |
List ID string / Required listId | The ID of the list. |
Project ID string / Required projectId | The ID of the project. |
Get List Of Attachments
Retrieve details about all of the attachments belonging to a particular task. | key: getListOfAttachments
| Input | Notes |
|---|---|
Connection connection / Required connection | |
List ID string / Required listId | The ID of the list. |
Project ID string / Required projectId | The ID of the project. |
Task ID string / Required taskId | The ID of the task. |
Get Page
Retrieves the details of an existing page. | key: getPage
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Page ID string / Required pageId | The ID of the page. |
Get Project
Retrieves the details of an individual existing project given a project id. Use the special project ID me to return your personal project. | key: getProject
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Project ID string / Required projectId | The ID of the project. |
Get Project Members
Retrieves a list of ids of the users that are members of the given project id. | key: getProjectMembers
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Project ID string / Required projectId | The ID of the project. |
Get Stream
Retrieves the details of an existing stream. | key: getStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Fields string fields | Return desired fields: {all} or {id, dataset, updateMethod, createdAt, or modifiedAt} |
Stream ID string / Required streamId | The id of the stream. |
Get Stream Execution
Import data into a DataSet in your Domo instance. This request will replace the data currently in the DataSet. | key: getStreamExecution
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Execution ID string / Required executionId | The ID of the Stream execution within the Stream. |
Stream ID string / Required streamId | The ID of the Stream of data being imported into a DataSet. |
Get Task
Retrieves an individual task from a given project id and list id. | key: getTask
| Input | Notes |
|---|---|
Connection connection / Required connection | |
List ID string / Required listId | The ID of the list. |
Project ID string / Required projectId | The ID of the project. |
Task ID string / Required taskId | The ID of the task. |
Get User
Retrieves the details of an existing user. | key: getUser
| Input | Notes |
|---|---|
Connection connection / Required connection | |
User ID string / Required userId | The ID of the user. |
Import Data Into DataSet
Import data into a DataSet in your Domo instance. This request will replace the data currently in the DataSet. | key: importDataIntoDataSet
| Input | Notes |
|---|---|
Connection connection / Required connection | |
CSV Body text / Required csvBody | |
DataSet ID string / Required datasetId | The ID of the DataSet. |
List Accounts
Get a list of all Accounts for which the user has permissions. | key: listAccounts
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The number of Accounts to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of Accounts to begin the list of Accounts within the response. |
List DataSets
Get a list of all DataSets in your Domo instance. | key: listDataSets
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The amount of DataSets to return in the list. The default is 50 and the maximum is 50. |
Name Like string nameLike | If included, will limit the list of DataSets to those with names that contain the string passed in. nameLike is case insensitive. |
Offset string offset | The offset of the DataSet ID to begin list of users within the response. |
Sort string sort | The DataSet field to sort by. Fields prefixed with a negative sign reverses the sort (i.e. '-name' does a reverse sort by the name of the DataSets). |
List Groups
Get a list of all groups in your Domo instance. | key: listGroups
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The amount of groups to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the group ID to begin list of groups within the response. |
List Pages
Get a list of all pages in your Domo instance. | key: listPages
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The amount of pages to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the page ID to begin list of pages within the response. |
List Project List Tasks
Retrieves all tasks from a given project id and list id. | key: listProjectListTasks
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The number of records to offset from the beginning of the result list (defaults to 0) |
List ID string / Required listId | The ID of the list. |
Offset string offset | The maximum amount of results to return (defaults to 10 with a maximum of 50) |
Project ID string / Required projectId | The ID of the project. |
List Project Lists
Retrieves all lists available within a given project id. | key: listProjectLists
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Project ID string / Required projectId | The ID of the project. |
List Projects
Retrieves a list of all projects that the client scope has access to. | key: listProjects
| Input | Notes |
|---|---|
Connection connection / Required connection |
List Stream Execution
Returns all Stream Execution objects that meet argument criteria from original request. | key: listStreamExecution
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The amount of Stream to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the Stream ID to begin list of users within the response. |
Stream ID string / Required streamId | The ID of the Stream |
List Streams
Get a list of all Streams for which the user has view permissions. | key: listStreams
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The amount of Stream to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the Stream ID to begin list of users within the response. |
List Users
Get a list of all users in your Domo instance. | key: listUsers
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Limit string limit | The amount of users to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the user ID to begin list of users within the response. |
List Users In Group
List the users in a group in your Domo instance. | key: listUsersInGroup
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Group ID string / Required groupId | The ID of the group. |
Limit string limit | The amount of groups to return in the list. The default is 50 and the maximum is 500. |
Offset string offset | The offset of the group ID to begin list of groups within the response. |
Query Data Set
Queries the data in an existing Domo DataSet | key: queryDataSet
| Input | Notes |
|---|---|
Connection connection / Required connection | |
DataSet ID string / Required datasetId | The ID of the DataSet. |
SQL string / Required sql | The SQL query to execute. |
Raw Request
Send raw HTTP request to Domo. | key: rawRequest
| Input | Default | Notes | Example |
|---|---|---|---|
Connection connection / Required connection | |||
Data string data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} | |
Debug Request boolean debugRequest | false | Enabling this flag will log out the current request. | |
File Data string Key Value List fileData | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] | |
File Data File Names string Key Value List fileDataFileNames | File names to apply to the file data inputs. Keys must match the file data keys above. | ||
Form Data string Key Value List formData | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] | |
Header string Key Value List headers | A list of headers to send with the request. | User-Agent: curl/7.64.1 | |
Max Retry Count string maxRetries | 0 | The maximum number of retries to attempt. | |
Method string / Required method | The HTTP method to use. | ||
Query Parameter string Key Value List queryParams | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | ||
Response Type string / Required responseType | json | The type of data you expect in the response. You can request json, text, or binary data. | |
Retry On All Errors boolean retryAllErrors | false | If true, retries on all erroneous responses regardless of type. | |
Retry Delay (ms) string retryDelayMS | 0 | The delay in milliseconds between retries. | |
Timeout string timeout | The maximum time that a client will await a response to its request | 2000 | |
URL string / Required url | This is the URL to call. | /datasets | |
Use Exponential Backoff boolean useExponentialBackoff | false | Specifies whether to use a pre-defined exponential backoff strategy for retries. |
Remove User From Group
Remove a user from a group in your Domo instance. | key: removeUserFromGroup
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Group ID string / Required groupId | The ID of the group. |
User ID string / Required userId | The ID of the user. |
Search Stream
Returns all Stream objects that meet argument criteria from original request. | key: searchStream
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Fields string fields | Return desired fields: {all} or {id, dataset, updateMethod, createdAt, or modifiedAt} |
Qualifiers string / Required qualifiers | The search qualifiers to search by available qualifiers: dataSource.id or dataSource.owner.id |
Share Account
Share an Account with a User. | key: shareAccount
| Input | Notes |
|---|---|
Account ID string / Required accountId | The ID of the Account. |
Connection connection / Required connection | |
User string / Required Value List userArray | The User to share the Account with. |
Update Account
Updates the specified Account’s metadata as well as the Account’s Type properties. | key: updateAccount
| Input | Notes | Example |
|---|---|---|
Account ID string / Required accountId | The ID of the account to update. | |
Connection connection / Required connection | ||
Update Account Body code / Required updateAccountBody |
Update Data Set
Updates the specified DataSet’s metadata by providing values to parameters passed. | key: updateDataSet
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
DataSet ID string / Required datasetId | The ID of the DataSet. | |
Update DataSet Body code updateDataSetBody |
Update Group
Updates the specified group by providing values to parameters passed. Any parameter left out of the request will cause the specific group’s attribute to remain unchanged. | key: updateGroup
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Group ID string / Required groupId | The ID of the group. | |
Update Group Body code updateGroupBody |
Update List
Update the details of a list given an existing project id and list id. | key: updateList
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Index string / Required index | The updated index of the list within the project. Updating the index of a list may also change the order of the other lists in the project to remain sequential. | |
List ID string / Required listId | The ID of the list. | |
Name string / Required name | The updated name of the list. | |
Project ID string / Required projectId | The ID of the project. | |
Type string / Required type | The type of the list. | |
Update List Body code updateListBody |
Update Page
Updates the specified page by providing values to parameters passed. Any parameter left out of the request will cause the specific page’s attribute to remain unchanged. | key: updatePage
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Page ID string / Required pageId | The ID of the page. | |
Update Page Body code / Required updatePageBody |
Update Project
Updates attributes of an existing project in your Domo instance. The following properties are read-only and cannot be updated with this request:id members createdBy createdDate | key: updateProject
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Description string description | Updates the description of the project. | |
Due Date string dueDate | Updates the due date of the project. | |
Name string name | Updates the name of the project. | |
Project ID string / Required projectId | The ID of the project. | |
Public string publicUpdate | Updates whether or not the project is publicly available to Domo users. | |
Update Project Body code updateProjectBody |
Update Project Members
Update the members of a given project id. | key: updateProjectMembers
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Project ID string / Required projectId | The ID of the project. | |
Update Project Members Body code updateProjectMembersBody |
Update Stream
Updates the specified Stream’s metadata by providing values to parameters passed. | key: updateStream
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Stream ID string / Required streamId | The ID of the stream to update. | |
Update Method Body code updateMethodBody | ||
Update Method string / Required updateMethodString | The data import behavior. |
Update Task
Update the details of a task given an existing project id, list id, and task id. | key: updateTask
| Input | Notes | Example |
|---|---|---|
Connection connection / Required connection | ||
Contributors string contributors | An array of user IDs that are assigned as contributors to the task. | |
Description string / Required description | Description of the DataSet to create | |
Due Date string dueDate | The due date of the project | |
List ID string / Required listId | The ID of the list. | |
Owned By string ownedBy | The ID of the Domo user that owns the task. | |
Priority string priority | Priority of task within a list. Setting this property will impact the index of other tasks in the list to maintain sequential order. If not provided the priority will default to 1 and the index of all the other tasks in the list will shift. | |
Project ID string / Required projectId | The ID of the project. | |
Tags string tags | An array of tags that have been assigned to the task. | |
Task ID string / Required taskId | The ID of the task. | |
Task Name string / Required taskName | The name of the task. | |
Update Task Body code updateTaskBody |
Update User
Updates the specified user by providing values to parameters passed. Any parameter left out of the request will cause the specific user’s attribute to remain unchanged. | key: updateUser
| Input | Default | Notes | Example |
|---|---|---|---|
Alternate Email string alternateEmail | User's secondary email in profile. | ||
Connection connection / Required connection | |||
Email string email | User's primary email used in profile. | ||
Employee Number string employeeNumber | Employee number within company. | ||
Locale string locale | Locale used to display to user the system settings throughout Domo application. | ||
Location string location | Free text that can be used to define office location. | ||
Name string name | User's full name | ||
Phone string phone | Primary phone number of user. | ||
Role string role | Admin | The system role of the user | |
Roled string roled | The ID of the custom or system role of the user. | ||
Timezone string timezone | Time zone used to display to user the system times throughout Domo application. | ||
Title string title | User's job title. | ||
Update User Body code updateUserBody | |||
User ID string / Required userId | The ID of the user. |
Upload Data Part
Creates a data part within the Stream execution to upload chunks of rows to the DataSet. The calling client should keep track of parts and order them accordingly in an increasing sequence. If a part upload fails, retry the upload as all parts must be present before committing the stream execution. | key: uploadDataPart
| Input | Notes |
|---|---|
Connection connection / Required connection | |
Execution ID string / Required executionId | The ID of the Stream execution within the Stream. |
Part ID string / Required partId | The ID of the data part being used to upload a subset of data within the Stream execution. |
Stream ID string / Required streamId | The ID of the Stream of data being imported into a DataSet. |