{ "operations": [ { "name": "getCases", "params": [ "query", "options", "callback" ], "docs": { "description": "Use this function to get cases from Primero based on a set of query parameters.\nNote that in many implementations, the `remote` attribute should be set to `true` to ensure that only cases marked for remote access will be retrieved.\nSet `case_id` on the query object to fetch a specific case.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "getCases();", "caption": "Fetch all cases" }, { "title": "example", "description": "getCases({\n remote: true,\n sex: \"male\",\n age: \"10..15\",\n protection_concerns :\"unaccompanied,separated\",\n});", "caption": "Fetch all cases which match query criteria" }, { "title": "example", "description": "getCases({\n case_id: \"6aeaa66a-5a92-4ff5-bf7a-e59cde07eaaz\",\n});", "caption": "Fetch a specific case by id" }, { "title": "example", "description": "getCases(\n { remote: true },\n { withReferrals: true }\n);", "caption": "Get all remote cases and their referrals" }, { "title": "param", "description": "Query parameters to send to primero, which will be built into URL parameters. See {@link https://github.com/primeroIMS/primero/blob/master/doc/api/cases/get.md Primero Docs} for a list of valid parameters.", "type": { "type": "NameExpression", "name": "object" }, "name": "query" }, { "title": "param", "description": "(Optional) Additional options", "type": { "type": "NameExpression", "name": "object" }, "name": "options" }, { "title": "param", "description": "Set to true to include referrals with each case. This will generate an extra request for each case and may take some time to process.", "type": { "type": "NameExpression", "name": "boolean" }, "name": "options.withReferrals" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": false }, { "name": "createCase", "params": [ "params", "callback" ], "docs": { "description": "Create a new case in Primero\n\nUse this function to create a new case in Primero based on a set of Data.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "createCase({\n data: {\n age: 16,\n sex: \"female\",\n name: \"Edwine Edgemont\",\n },\n});", "caption": "Create a new case in Primero based on a set of Data" }, { "title": "function", "description": null, "name": null }, { "title": "param", "description": "an object with some case data.", "type": { "type": "NameExpression", "name": "object" }, "name": "params" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "updateCase", "params": [ "id", "params", "callback" ], "docs": { "description": "Update an existing case in Primero\n\nUse this function to update an existing case from Primero.\nIn this implementation, the function uses a case ID to check for the case to update,\nThen merge the values submitted in this call into an existing case.\nFields not specified in this request will not be modified.\nFor nested subform fields, the subform arrays will be recursively merged,\nkeeping both the existing values and appending the new", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "updateCase(\"6aeaa66a-5a92-4ff5-bf7a-e59cde07eaaz\", {\n data: {\n age: 16,\n sex: \"female\",\n name: \"Fiona Edgemont\",\n },\n});", "caption": "Update case for a specific case id" }, { "title": "function", "description": null, "name": null }, { "title": "param", "description": "A case ID to use for the update.", "type": { "type": "NameExpression", "name": "string" }, "name": "id" }, { "title": "param", "description": "an object with some case data.", "type": { "type": "NameExpression", "name": "object" }, "name": "params" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "upsertCase", "params": [ "params", "callback" ], "docs": { "description": "Upsert case to Primero\n\nUse this function to update an existing case from Primero or to create it otherwise.\nIn this implementation, we first fetch the list of cases,\nthen we check if the case exist before choosing the right operation to do.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "upsertCase({\n externalIds: [\"case_id\"],\n data: state => ({\n age: 20,\n sex: \"male\",\n name: \"Alex\",\n status: \"open\",\n case_id: \"6aeaa66a-5a92-4ff5-bf7a-e59cde07eaaz\",\n }),\n});", "caption": "Upsert case for a specific case id" }, { "title": "function", "description": null, "name": null }, { "title": "param", "description": "an object with an externalIds and some case data.", "type": { "type": "NameExpression", "name": "object" }, "name": "params" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "getReferrals", "params": [ "params", "callback" ], "docs": { "description": "Get referrals for a specific case in Primero\n\nUse this function to get the list of referrals of one case from Primero.\nThe search can be done using either `record id` or `case id`.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "getReferrals({\n externalId: \"record_id\",\n id: \"6aeaa66a-5a92-4ff5-bf7a-e59cde07eaaz\",\n});", "caption": "Get referrals for a case in Primero by record id" }, { "title": "example", "description": "getReferrals({\n id: \"6aeaa66a-5a92-4ff5-bf7a-e59cde07eaaz\",\n});", "caption": "Get referrals for a case in Primero by case id" }, { "title": "function", "description": null, "name": null }, { "title": "param", "description": "an object with an externalId field to select the attribute to use for matching on case and an externalId value for that case.", "type": { "type": "NameExpression", "name": "object" }, "name": "params" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "createReferrals", "params": [ "params", "callback" ], "docs": { "description": "Create referrals in Primero\n\nUse this function to bulk refer to one or multiple cases from Primero to a single user", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "createReferrals({\n data: {\n ids: [\n \"749e9c6e-60db-45ec-8f5a-69da7c223a79\",\n \"dcea6052-07d9-4cfa-9abf-9a36987cdd25\",\n ],\n transitioned_to: \"primero_cp\",\n notes: \"This is a bulk referral\",\n },\n});", "caption": "Create referrals for multiple cases in Primero" }, { "title": "function", "description": null, "name": null }, { "title": "param", "description": "an object with referral data.", "type": { "type": "NameExpression", "name": "object" }, "name": "params" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "updateReferral", "params": [ "params", "callback" ], "docs": { "description": "Update a single referral for a specific case in Primero", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "updateReferral({\n caseExternalId: \"record_id\",\n id: \"749e9c6e-60db-45ec-8f5a-69da7c223a79\",\n caseId: \"dcea6052-07d9-4cfa-9abf-9a36987cdd25\",\n data: (state) => state.data,\n});", "caption": "Update referral by record id" }, { "title": "function", "description": null, "name": null }, { "title": "param", "description": "an object with an caseExternalId value to use, the id and the referral id to update.", "type": { "type": "NameExpression", "name": "object" }, "name": "params" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "getForms", "params": [ "query", "callback" ], "docs": { "description": "Get forms from Primero\n\nUse this function to get forms from Primero that are accessible to this user based on a set of query parameters.\nThe user can filter the form list by record type and module.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "getForms();", "caption": "Get the list of all forms" }, { "title": "example", "description": "getForms({\n module_id: \"6aeaa66a-5a92-4ff5-bf7a-e59cde07eaaz\",\n});", "caption": "Get the list of all forms for a specific module" }, { "title": "function", "description": null, "name": null }, { "title": "param", "description": "an object with a query param at minimum", "type": { "type": "NameExpression", "name": "object" }, "name": "query" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "getLookups", "params": [ "query", "callback" ], "docs": { "description": "Get lookups from Primero\n\nUse this function to get a paginated list of all lookups that are accessible to this user from Primero.\nNote: You can specify a `per` value to fetch records per page(Defaults to 20).\nAlso you can specify `page` value to fetch pagination (Defaults to 1)", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "getLookups({\n per: 10000,\n page: 5\n});", "caption": "Get lookups from Primero with query parameters" }, { "title": "function", "description": null, "name": null }, { "title": "param", "description": "an object with a query param at minimum", "type": { "type": "NameExpression", "name": "object" }, "name": "query" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "getLocations", "params": [ "query", "callback" ], "docs": { "description": "Get locations from Primero\n\nUse this function to get a paginated list of all locations that are accessible to this user from Primero.\nNote: You can specify a `per` value to fetch records per page(Defaults to 20).\nAlso you can specify `page` value to fetch pagination (Defaults to 1).\nAnother parameter is `hierarchy: true` (Defaults to false)", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "getLocations({\n page: 1,\n per: 20\n})", "caption": "Get loocations from Primero with query parameters" }, { "title": "function", "description": null, "name": null }, { "title": "param", "description": "an object with a query param at minimum", "type": { "type": "NameExpression", "name": "object" }, "name": "query" }, { "title": "param", "description": "(Optional) Callback function", "type": { "type": "NameExpression", "name": "function" }, "name": "callback" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true } ], "exports": [], "common": [ { "name": "fn", "params": [ "func" ], "docs": { "description": "Creates a custom step (or operation) for more flexible job writing.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "fn(state => {\n // do some things to state\n return state;\n});" }, { "title": "param", "description": "is the function", "type": { "type": "NameExpression", "name": "Function" }, "name": "func" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "fnIf", "params": [ "condition", "operation" ], "docs": { "description": "Execute a function only when the condition returns true", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "fnIf((state) => state?.data?.name, get(\"https://example.com\"));" }, { "title": "param", "description": "The condition that returns true", "type": { "type": "NameExpression", "name": "Boolean" }, "name": "condition" }, { "title": "param", "description": "The operation needed to be executed.", "type": { "type": "NameExpression", "name": "Operation" }, "name": "operation" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "sourceValue", "params": [ "path" ], "docs": { "description": "Picks out a single value from source data.\nIf a JSONPath returns more than one value for the reference, the first\nitem will be returned.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "sourceValue('$.key')" }, { "title": "param", "description": "JSONPath referencing a point in `state`.", "type": { "type": "NameExpression", "name": "String" }, "name": "path" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "dataPath", "params": [ "path" ], "docs": { "description": "Ensures a path points at the data.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "dataPath('key')" }, { "title": "param", "description": "JSONPath referencing a point in `data`.", "type": { "type": "NameExpression", "name": "string" }, "name": "path" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "string" } } ] }, "valid": true }, { "name": "dataValue", "params": [ "path" ], "docs": { "description": "Picks out a single value from the source data object—usually `state.data`.\nIf a JSONPath returns more than one value for the reference, the first\nitem will be returned.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "dataValue('key')" }, { "title": "param", "description": "JSONPath referencing a point in `data`.", "type": { "type": "NameExpression", "name": "String" }, "name": "path" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "lastReferenceValue", "params": [ "path" ], "docs": { "description": "Picks out the last reference value from source data.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "lastReferenceValue('key')" }, { "title": "param", "description": "JSONPath referencing a point in `references`.", "type": { "type": "NameExpression", "name": "String" }, "name": "path" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "each", "params": [ "dataSource", "operation" ], "docs": { "description": "Iterates over an array of items and invokes an operation upon each one, where the state\nobject is _scoped_ so that state.data is the item under iteration.\nThe rest of the state object is untouched and can be referenced as usual.\nYou can pass an array directly, or use lazy state or a JSONPath string to\nreference a slice of state.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "each(\n $.data,\n // Inside the callback operation, `$.data` is scoped to the item under iteration\n insert(\"patient\", {\n patient_name: $.data.properties.case_name,\n patient_id: $.data.case_id,\n })\n);", "caption": "Using lazy state ($) to iterate over items in state.data and pass each into an \"insert\" operation" }, { "title": "example", "description": "each(\n $.data,\n insert(\"patient\", (state) => ({\n patient_id: state.data.case_id,\n ...state.data\n }))\n);", "caption": "Iterate over items in state.data and pass each one into an \"insert\" operation" }, { "title": "example", "description": "each(\n \"$.data[*]\",\n insert(\"patient\", (state) => ({\n patient_name: state.data.properties.case_name,\n patient_id: state.data.case_id,\n }))\n);", "caption": "Using JSON path to iterate over items in state.data and pass each one into an \"insert\" operation" }, { "title": "param", "description": "JSONPath referencing a point in `state`.", "type": { "type": "NameExpression", "name": "DataSource" }, "name": "dataSource" }, { "title": "param", "description": "The operation needed to be repeated.", "type": { "type": "NameExpression", "name": "Operation" }, "name": "operation" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "combine", "params": [ "operations" ], "docs": { "description": "Combines two operations into one", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "combine(\n create('foo'),\n delete('bar')\n)" }, { "title": "param", "description": "Operations to be performed.", "type": { "type": "NameExpression", "name": "Operations" }, "name": "operations" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true }, { "name": "field", "params": [ "key", "value" ], "docs": { "description": "Returns a key, value pair in an array.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "field('destination_field_name__c', 'value')" }, { "title": "param", "description": "Name of the field", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "param", "description": "The value itself or a sourceable operation.", "type": { "type": "NameExpression", "name": "Value" }, "name": "value" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Field" } } ] }, "valid": true }, { "name": "fields", "params": [ "fields" ], "docs": { "description": "Zips key value pairs into an object.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "fields(list_of_fields)" }, { "title": "param", "description": "a list of fields", "type": { "type": "NameExpression", "name": "Fields" }, "name": "fields" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Object" } } ] }, "valid": true }, { "name": "merge", "params": [ "dataSource", "fields" ], "docs": { "description": "Merges fields into each item in an array.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "example", "description": "merge(\n \"$.books[*]\",\n fields(\n field( \"publisher\", sourceValue(\"$.publisher\") )\n )\n)" }, { "title": "function", "description": null, "name": null }, { "title": "public", "description": null, "type": null }, { "title": "param", "description": null, "type": { "type": "NameExpression", "name": "DataSource" }, "name": "dataSource" }, { "title": "param", "description": "Group of fields to merge in.", "type": { "type": "NameExpression", "name": "Object" }, "name": "fields" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "DataSource" } } ] }, "valid": true }, { "name": "as", "params": [ "key", "operation" ], "docs": { "description": "Run an operation and save the result to a custom key in state instead of overwriting state.data.", "tags": [ { "title": "public", "description": null, "type": null }, { "title": "function", "description": null, "name": null }, { "title": "example", "description": "as('cceData', collections.get('cce-data-dhis2', { key: `*:*:${$.syncedAt}*` }));", "caption": "Fetch cce-data from collections and store them under state.cceData" }, { "title": "param", "description": "The state key to assign the result of the operation to.", "type": { "type": "NameExpression", "name": "string" }, "name": "key" }, { "title": "param", "description": " An operation that returns a new state object with a `data` property", "type": { "type": "NameExpression", "name": "function" }, "name": "operation" }, { "title": "returns", "description": null, "type": { "type": "NameExpression", "name": "Operation" } } ] }, "valid": true } ] }