NAiOS IconNAiOS Logo
Contacto
Volver al catálogo

CommCare

commcare

CommCare is a mobile data collection and case management platform for health and social programs

Forms & SurveysDeveloper ToolsWeb del proveedor
Acciones
6
Triggers
0
Autenticación
—
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (6)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Create Lookup TableCOMMCARE_CREATE_LOOKUP_TABLEAcción

Tool to create a new lookup table in a CommCare domain. Use when you need to set up reference data structures like product catalogs, price lists, or configuration tables. Requires 'Edit Apps' permission.

Parámetros de entrada

  • tagstringObligatorio

    The name/identifier of the lookup table. This is used to reference the table in applications.

  • domainstringObligatorio

    The CommCare domain/project identifier where the lookup table will be created.

  • fieldsobject[]Obligatorio

    Array of field definitions for the lookup table. Each field must have a field_name and optional properties array.

  • is_globalboolean

    Indicates whether the lookup table is accessible to all users in the domain. Defaults to false if not specified.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Web User InvitationCOMMCARE_CREATE_WEB_USER_INVITATIONAcción

Tool to create an invitation for a new web user in CommCare. Use when you need to invite a user with specific role and permissions. Requires 'Edit Web Users & Edit Access API' permissions.

Parámetros de entrada

  • rolestringObligatorio

    Role designation for the user (e.g., 'App Editor', 'Admin')

  • emailstringObligatorio

    Email address of the user to invite

  • domainstringObligatorio

    CommCare domain name where the invitation will be created

  • profilestring

    Profile to assign to the user

  • user_dataobject

    Custom data fields associated with the user

  • tableau_rolestring

    Tableau role (Explorer, ExplorerCanPublish, SiteAdministratorExplorer, Viewer, Unlicensed)

  • tableau_groupsstring[]

    List of Tableau groups for user assignment

  • primary_location_idstring

    Location ID for primary assignment (must be in assigned locations)

  • assigned_location_idsstring[]

    List of location IDs the web user will access

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ReportsCOMMCARE_LIST_REPORTSAcción

Tool to retrieve available reports configured in a CommCare project. Use when you need to discover what reports exist before downloading report data via the Download Report Data API.

Parámetros de entrada

  • projectstringObligatorio

    The CommCare project identifier. This is the project space name where reports are configured.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Single Sign OnCOMMCARE_SINGLE_SIGN_ONAcción

Tool to validate login credentials and retrieve user profile for a mobile worker or web user. Use when you need to authenticate a user and obtain their profile information including roles, permissions, locations, and configuration details.

Parámetros de entrada

  • domainstringObligatorio

    The CommCare domain/project identifier where the user account exists.

  • passwordstringObligatorio

    The user's authentication password for login validation.

  • usernamestringObligatorio

    The user's login identifier (mobile worker or web user username).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Submit Form to CommCareCOMMCARE_SUBMIT_FORMAcción

Tool to submit an XForm to CommCare following the OpenRosa standard. Use when you need to submit form data with complete XML including required metadata fields (deviceID, timeStart, timeEnd, username, userID, instanceID).

Parámetros de entrada

  • domainstringObligatorio

    The CommCare project domain where the form will be submitted.

  • form_xmlstringObligatorio

    Complete XForm XML content following OpenRosa standard. Must include required metadata: deviceID, timeStart, timeEnd, username, userID, and instanceID (UUID4). The XML root element should have 'name', 'version', and 'xmlns' attributes.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Submit Form ODK CompatibleCOMMCARE_SUBMIT_FORM_ODK_COMPATIBLEAcción

Tool to submit form data using ODK-compatible endpoint for Android client compatibility. Use when submitting XForm data to CommCare. Requires properly formatted XML with metadata including unique instanceID.

Parámetros de entrada

  • domainstringObligatorio

    The CommCare project domain name where the form will be submitted.

  • xml_form_datastringObligatorio

    Complete XForm XML data as a string. Must include root <data> element with xmlns, name, and version attributes. Must contain an n1:meta node with required fields: deviceID, timeStart (ISO 8601), timeEnd (ISO 8601), username, userID (UUID), and instanceID (UUID4, must be unique).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not