metamaps--metamaps/doc/api/apis/mappings.raml

94 lines
2.6 KiB
Text
Raw Permalink Normal View History

2016-10-04 04:11:58 +00:00
#type: collection
get:
is: [ embeddable: { embedFields: "user,updated_by,map" }, orderable, pageable ]
securedBy: [ null, token, oauth_2_0 ]
responses:
200:
body:
application/json:
example: !include ../examples/mappings.json
post:
body:
application/json:
properties:
mappable_id:
description: id of the topic/synapse to be mapped
mappable_type:
description: Topic or Synapse
map_id:
description: id of the map
xloc:
2016-10-04 07:30:06 +00:00
description: (only for Topic mappings) x location on the canvas
required: false
yloc:
2016-10-04 07:30:06 +00:00
description: (only for Topic mappings) y location on the canvas
required: false
responses:
201:
body:
application/json:
example: !include ../examples/mapping.json
/{id}:
2016-10-04 04:11:58 +00:00
#type: item
get:
is: [ embeddable: { embedFields: "user,updated_by,map" } ]
securedBy: [ null, token, oauth_2_0 ]
responses:
200:
body:
application/json:
example: !include ../examples/mapping.json
put:
body:
application/json:
properties:
mappable_id:
description: id of the topic/synapse to be mapped
2016-10-04 07:30:06 +00:00
required: false
mappable_type:
description: Topic or Synapse
2016-10-04 07:30:06 +00:00
required: false
map_id:
description: id of the map
2016-10-04 07:30:06 +00:00
required: false
xloc:
description: (only for Topic mappings) x location on the canvas
required: false
yloc:
description: (only for Topic mappings) y location on the canvas
required: false
responses:
200:
body:
application/json:
example: !include ../examples/mapping.json
patch:
body:
application/json:
properties:
mappable_id:
description: id of the topic/synapse to be mapped
2016-10-04 07:30:06 +00:00
required: false
mappable_type:
description: Topic or Synapse
2016-10-04 07:30:06 +00:00
required: false
map_id:
description: id of the map
2016-10-04 07:30:06 +00:00
required: false
xloc:
description: (only for Topic mappings) x location on the canvas
required: false
yloc:
description: (only for Topic mappings) y location on the canvas
required: false
responses:
200:
body:
application/json:
example: !include ../examples/mapping.json
delete:
responses:
204:
description: No content