JourneyApps API - Docs & Resources

Creating a Single New Object

This function creates a single new object of the given type.

Relative URL	HTTP Request Method
/api/v1/object-type.format	POST

Note: Replace object-type with the type of object that you wish to create (as defined in your app's Data Model), for example 'person', 'job' or 'asset'. Replace format with the response data format (json or xml), or leave it out.

Parameters

A hash needs to supplied containing the following:

Attributes: Attributes as defined in your app's Data Model
Relationships: IDs of related objects that the object belongs to specified by using the relationship name and appending it with _id

For the format of all the different attribute types, see the Attribute Representation section.

The key of this hash has to be the name of the object type (see example below). In the following example of parameters in JSON format, the object type name is car and it has three attributes: make, model and number_plate and one relationship: it belongs to a warehouse.

{
  "car": {
    "make": "Toyota",
    "model": "Land Cruiser 100",
    "number_plate": "ABC123",
    "warehouse_id": "55c1a6a0-f1b8-11e1-a7df-001cc01904e3"
  }
}

Please Note: Setting photo and signature attributes is not yet supported by the JourneyApps API. If a parameter for a photo or signature attribute is supplied to the JourneyApps API, it will be ignored. Take a look at Attribute Representation for more details.

Response

The response includes the single newly created object. The format of the object is the same as for Retrieving All Objects.

Example

Parameters as URL-encoded key-value pairs: (refer to Request Parameter Formats)

curl https://run-testing.journeyapps.com/api/v1/tasks.json \
     -u '503b783fd6fb307677000006:nKXd8v54R9W3aE_qTo4-' \
     -d "task[name]=My%20First%20Task" \
     -d "task[instructions]=Please%20fill%20in%20document%20A" \
     -d "task[status]=1"

{
  "_updated_at": "2012-08-29T09:05:26Z",
  "instructions": "Please fill in document A",
  "name": "My First Task",
  "status": 1,
  "id": "ac5b86e8-f1b8-11e1-a7df-001cc01904e3",
  "display_name": "My First Task",
  "display_attachments": {
  }
}

Parameters as JSON:

Tip: The -H parameter to curl allows you to specify a custom HTTP header.

curl https://run-testing.journeyapps.com/api/v1/tasks.json \
     -u '503b783fd6fb307677000006:nKXd8v54R9W3aE_qTo4-' \
     -H "Content-Type: application/json" \
     -d '{"task":{"name":"My First Task","instructions":"Please fill in document A","status":1}}'

Bulk/Batch Creating Objects

You can create multiple objects of the same type in one operation by changing the hash in your parameters to an array of hashes.

For example, by using these parameters, we would be able to create two objects at once:

{
  "task": [
    {
      "name": "My First Task",
      "instructions": "Please fill in document A",
      "status": 1
    }, {
      "name": "My Second Task",
      "instructions": "Please fill in document B", "status": 1
    }
  ]
}

An example of an API call with curl with the above parameters:

curl https://run-testing.journeyapps.com/api/v1/tasks.json \
     -u '503b783fd6fb307677000006:nKXd8v54R9W3aE_qTo4-' \
     -H "Content-Type: application/json" \
     -d '{"task":[{"name":"My First Task","instructions":"Please fill in document A","status":1}, {"name":"My Second Task","instructions":"Please fill in document B","status":1}]}'

An array of all the objects that were created will be returned in the response:

[
  {
    "_updated_at": "2014-04-02T09:40:02Z",
    "instructions": "Please fill in document A",
    "name": "My First Task",
    "status": 1,
    "id": "c3d3db52-ba4a-11e3-a567-001e6733fe3c",
    "display_name": "My First Task",
    "display_attachments": {
    }
  },
  {
    "_updated_at": "2014-04-02T09:40:02Z",
    "instructions": "Please fill in document B",
    "name": "My Second Task",
    "status": 1,
    "id": "c3d59ff0-ba4a-11e3-a567-001e6733fe3c",
    "display_name": "My Second Task",
    "display_attachments": {
    }
  }
]

Next Section: 4. Retrieving a Single Object

Previous Section Next Section

The JourneyApps API (V1) → 3. Creating New Objects

Creating a Single New Object

Parameters

Response

Example

Bulk/Batch Creating Objects