Skip to content
Ishvana Ishvana Docs

Get Map Detail

GET
/api/creative/lore/maps/{map_id}

Get full map detail including all objects.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
map_id
required
Map Id
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

MapDetailResponse

Full map with all objects — returned by GET /maps/{id}.

object
map
required
WorldMapResponse
object
id
required
Id
string
projectId
required
Projectid
string
title
required
Title
string
description
required
Description
string
imageFilename
required
Imagefilename
string
imageUrl
required
Imageurl
string
imageWidth
required
Imagewidth
integer
imageHeight
required
Imageheight
integer
imageSizeBytes
required
Imagesizebytes
integer
parentMapId
Any of:
string
parentMapTitle
Any of:
string
scalePixelsPerUnit
Any of:
number
scaleUnit
required
Scaleunit
string
pinCount
required
Pincount
integer
regionCount
required
Regioncount
integer
pathCount
required
Pathcount
integer
labelCount
required
Labelcount
integer
sortOrder
required
Sortorder
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer
pins
required
Pins
Array<object>
MapPinResponse
object
id
required
Id
string
mapId
required
Mapid
string
projectId
required
Projectid
string
label
required
Label
string
xPct
required
Xpct
number
yPct
required
Ypct
number
icon
required
Icon
string
color
required
Color
string
size
required
Size
string
legendCategoryId
Any of:
string
loreEntryId
Any of:
string
loreEntryTitle
Any of:
string
loreEntryType
Any of:
string
linkedMapId
Any of:
string
linkedMapTitle
Any of:
string
notes
required
Notes
string
minZoom
required
Minzoom
number
maxZoom
required
Maxzoom
number
sortOrder
required
Sortorder
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer
regions
required
Regions
Array<object>
MapRegionResponse
object
id
required
Id
string
mapId
required
Mapid
string
projectId
required
Projectid
string
label
required
Label
string
vertices
required
Vertices
Array<object>
Vertex

A point on the map in percentage coordinates.

object
xPct
required
Xpct
number
<= 100
yPct
required
Ypct
number
<= 100
fillColor
required
Fillcolor
string
fillOpacity
required
Fillopacity
number
strokeColor
required
Strokecolor
string
strokeWidth
required
Strokewidth
number
loreEntryId
Any of:
string
loreEntryTitle
Any of:
string
notes
required
Notes
string
minZoom
required
Minzoom
number
maxZoom
required
Maxzoom
number
sortOrder
required
Sortorder
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer
paths
required
Paths
Array<object>
MapPathResponse
object
id
required
Id
string
mapId
required
Mapid
string
projectId
required
Projectid
string
label
required
Label
string
vertices
required
Vertices
Array<object>
Vertex

A point on the map in percentage coordinates.

object
xPct
required
Xpct
number
<= 100
yPct
required
Ypct
number
<= 100
strokeColor
required
Strokecolor
string
strokeWidth
required
Strokewidth
number
strokeStyle
required
Strokestyle
string
showDirection
required
Showdirection
boolean
loreEntryId
Any of:
string
loreEntryTitle
Any of:
string
notes
required
Notes
string
minZoom
required
Minzoom
number
maxZoom
required
Maxzoom
number
sortOrder
required
Sortorder
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer
labels
required
Labels
Array<object>
MapLabelResponse
object
id
required
Id
string
mapId
required
Mapid
string
projectId
required
Projectid
string
text
required
Text
string
xPct
required
Xpct
number
yPct
required
Ypct
number
fontSize
required
Fontsize
number
color
required
Color
string
rotation
required
Rotation
number
fontStyle
required
Fontstyle
string
letterSpacing
required
Letterspacing
number
minZoom
required
Minzoom
number
maxZoom
required
Maxzoom
number
sortOrder
required
Sortorder
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer
legend
required
Legend
Array<object>
LegendCategoryResponse
object
id
required
Id
string
mapId
required
Mapid
string
projectId
required
Projectid
string
name
required
Name
string
icon
required
Icon
string
color
required
Color
string
visible
required
Visible
boolean
pinCount
required
Pincount
integer
sortOrder
required
Sortorder
integer
createdAt
required
Createdat
integer
modifiedAt
required
Modifiedat
integer

422

Section titled “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object