Description: This endpoint returns a list of all the Apps in the environment.

Description: This endpoint returns an object with the details of the app with this <id> number.

Description: This endpoint, when used without filters, returns an object with the name and _id of each atom in the corresponding app.

How to filter the results

For an example of the Get a List of Atoms endpoint in action see the Retrieve and Update example,  Retrieve and Approve example, and Retrieve Document IDs from DocumentFolder example.

Filter Structure (JSON)

[{"field":"<field name>","type":"<field type>","comparison":"<operator (if applicable)>","value":"<value>",}]

More Info

You can append the parameter fieldset={comma separated list of fields} to get specific fields back from the query.

IMPORTANT NOTE: System fields _id and name do not need to be prefixed with p_ but all the custom fields do.

How to Encode the Filter

Get the filter info from a dashboard grid.

Take that JSON hash and go here to encode it: http://meyerweb.com/eric/tools/dencoder/

Then take encoded value and put as the value of filter= in the url.

Response:

{"data"=>[{"name"=>"<name>", "_id"=>"<id>"}], "success"=>true, "count"=>1}

Description: This endpoint allows you to create new records in the corresponding app

For an example of the Create New Atom endpoint in action see here.

Description: This endpoint returns an object with details about an atom with this <id>

Description: This endpoint allows you to update fields in an atom with this <id>

For an example of the Update Atom endpoint in action see here.

JSON Body format (field_1 and field_2 are the fields you want to update):

{
    "atom":{
        "field_1":"value_1",
        "field_2":"value_2",
    }
}

Add Documents to Attachment Field

Below is a curl command that posts a file into an attachment field named test.

curl -X PUT --header "Accept: application/json" -F "atom[p_test][email protected]" -F "_attachment_fields[]=atom[p_test]" -k https://jpowers.prod-local.onitcorp.com/api/atoms/59930731ed404f5dce000660.json?auth_token=XYZ123 {"success":true,"message":"Update successful"}

Description: This endpoint allows you to delete the atom with <id> number

Description: This endpoint allows you change the phase of an atom with this <id>

Parameter: current_step=<new current step number>

Description: This endpoint allows you to reopen an atom with this <id>. That is to say, it changes the {{status}} variable back to "Pending"

Description: This endpoint returns a list of all history events for an atom with this <id>

Description: This endpoint will fire a pre-existing Action on a Record.

Name of the Action to be fired on the Record in the following format: reaction_name=<action name>

Note: The Action name may contain spaces.

For an example of the Approve endpoint in action see here.

Description: This endpoint returns an object with details about an atom with this <id>

Body: (http multi-part, not json):

{:comment=>{:notify_selected=>[],:message=>"api comment",:attachment=>#<File>}}

Description: This endpoint returns a list of all the files in a document folder field for one specific atom

For an example of the Get List of Files in a DocumentFolder Field endpoint in action see here.

Description: This endpoint allows you to add a file to document folder field of one specific atom

Body (http multi-part, not json):

{"document"=><File>, "_attachment_fields"=>["document"], "related_document_field"=>"<documentFolderName>", "label"=>"<document description>”}

API Response:

{"data"=>"<document id>", "success"=>true, "message"=>"Document created"}

Description: This endpoint allows you to delete a file from a document folder field of one specific atom

Body:

{"list_dictionary" :
{"name" : unqiue_name_of_list_dictionary, "display_name" : display_name,
     "primary_key" : attribute_name_of_primary_key
     "truncate_data" : true_(if_truncate_existing_data),
     "overwrite" :  true (if_redefine_dictionary),
     "properties" : [{"data_type" : type_of_field,
            "name" : unique_name_of_attribute,
            "display_name" : display_name
            "required" : true if required
       }]
    }
  }

File: csv, xls, or xlsx with header row of property name and successive rows of property values

Body:

{list:[{property_name: property_value},…]}

JSON Body: {“list”:{<attr1>:<value1>,<attr2>:<value2>}}