Skip to main content

magpi@1.0.0

Adaptor

Adaptor.execute(operations) ⇒ Operation

Execute a sequence of operations. Wraps @openfn/language-common/execute, and prepends initial state for magpi.

Kind: static method of Adaptor

ParamTypeDescription
operationsOperationsOperations to be performed.

Example

execute(
create('foo'),
delete('bar')
)(state)

Adaptor.fetchSurveyData(params) ⇒ Operation

Make a POST request to fetch Magpi data and POST it somewhere else

Kind: static method of Adaptor
Access: public

ParamTypeDescription
paramsobjectdata to make the fetch

Example

fetchSurveyData({
"surveyId": "37479",
"afterDate": "2017-09-27",
"postUrl": "https://www.openfn.org/inbox/your-inbox-url"
})

Adaptor.submitRecord(jsonData) ⇒ Operation

Submit a record for a form/survey which already exists in a Magpi user account

Kind: static method of Adaptor
Access: public

ParamTypeDescription
jsonDataobjectPayload data for the record

Example

submitRecord(jsonData)