Overlays

The Overlays service returns Overlays, which are collections of Shapes, for use in searching and display.

Supported Roles
Available Services
1. All Overlays
2. Individual Overlays
Overlays Description
Expansions

Supported Roles

Role	Reads	Writes
IDX	Yes	No
Public	Yes	No
VOW	Yes	No
Portal	Yes	No
Private	Yes	No

More information about roles may be found here.

Available Services

All Overlays

`/<API Version>/overlays`

HTTP Method	Description	Conditional	Notes
GET	Returns all overlays available to the user	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

Parameter	Required	Notes
Standard search and paging syntax	No

GET Response

{
    "D": {
        "Results": => [
            {
                "Id"=>"20200930182940798746000000",
                "ResourceUri"=>"/v1/overlays/20200930182940798746000000",
                "Name"=>"Big Shape",
                "OwnerId"=>"20000426143505724628000000",
                "Inherited"=>false,
                "CreatedTimestamp"=>"2020-09-30T18:29:40Z",
                "ModificationTimestamp"=>"2020-11-19T19:52:59Z",
                "Public"=>false,
                "Inheritable"=>false
            },
            {
                "Id"=>"20131203155800244279000000",
                "ResourceUri"=>"/v1/overlays/20131203155800244279000000",
                "Name"=>"cityscapes",
                "OwnerId"=>"20000426143505724628000000",
                "Inherited"=>false,
                "CreatedTimestamp"=>"2013-12-03T15:58:00Z",
                "ModificationTimestamp"=>"2013-12-03T15:58:00Z",
                "Public"=>false,
                "Inheritable"=>false
            }
        ],
        "Success": true
    }
}

Individual Overlay

`/<API Version>/overlays/<Overlay.Id>`

HTTP Method	Description	Conditional	Notes
GET	Returns a specified overlay record	No
POST	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
PUT	Returns HTTP 405 (Method Not Allowed)	No	Not implemented
DELETE	Returns HTTP 405 (Method Not Allowed)	No	Not implemented

GET Request

Parameters:

None

GET Response

{
    "D": {
        "Results": => [
            {
                "Id"=>"20200930182940798746000000",
                "ResourceUri"=>"/v1/overlays/20200930182940798746000000",
                "Name"=>"Big Shape",
                "OwnerId"=>"20000426143505724628000000",
                "Inherited"=>false,
                "CreatedTimestamp"=>"2020-09-30T18:29:40Z",
                "ModificationTimestamp"=>"2020-11-19T19:52:59Z",
                "Public"=>false,
                "Inheritable"=>false
            }
        ],
        "Success": true
    }
}

Overlays Description

Attribute	Data Type	Description
`Id`	Character	The unique id for the Overlay.
`ResourceUri`	Character	The URI to the Overlay.
`Name`	Character	The Name of the Overlay.
`OwnerId`	Character	The Account.Id of the Overlay's owner
`Inherited`	Boolean	Whether the overlay is inherited, ie., is owned by another user but is available to the current user.
`Inheritable`	Boolean	Whether the overlay can be inherited by other users.
`Public`	Boolean	Whether the overlay is intended to be publicly available.
`CreatedTimestamp`	DateTime	The time the overlay record was created
`ModificationTimestamp`	DateTime	The time the overlay record was last modified

Expansions

Expansion	Roles	Single Record Only?	Selection Support?	Description
`Shapes`	All	No	No	This expansion causes to be included all of the Shapes belonging to this overlay.