Skip to content

Instantly share code, notes, and snippets.

@justinbmeyer
Last active August 29, 2015 14:03
Show Gist options
  • Save justinbmeyer/3e48a819c3c2e1bb4c63 to your computer and use it in GitHub Desktop.
Save justinbmeyer/3e48a819c3c2e1bb4c63 to your computer and use it in GitHub Desktop.
Service Endpoint Example Documentation

Task

A task represents something to do. The task's service can CRUD tasks. Tasks can belong to other tasks and a single owner. Tasks have a belongs to and has many relationship with assignees.

create

Creates a task in the database.

url

POST /services/create

params

  • name :STRING name: "Dishes"

The name of the todo

  • ownerId :INT? ownerId: 5

The ownerId of the issue. If the current user is a manager, an ownerId can be provided to assign the task to someone else. Otherwise, ownerId is set as the current session owner.

  • assignees :Array? assignees: [3,4,5]

Assigns this task to multiple people.

  • dueDate :INT dueDate: 1403801116649

When the task is due as a julian timestamp.

Example:

{
  name: "Dishes", 
  dueDate: 1403801116649 // Jun 26, 2014
}

Response

  • id :STRING id: "354325-4354-23"

    The unique id of the todo

Example:

{
  "id": "354325-4354-23"
}

get many

...

update

...

destroy

...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment