List objects

get

https://mpulse.soasta.com/concerto/services/rest/RepositoryService/v1/Objects/{type}

Gets a list of repository objects, filtered by attributes.

Path Params

type

string

enum

required

Enum These are the available types for mPulse.

Allowed:

Query Params

deactivated

string

Filter to the objects that have been deactivated.

domain

string

Filter to the specified domain.

domaintype

string

enum

Enum Filter to the specified domain type: APP, WEB.

Allowed:

emailAddress

string

Filter to the specified email address.

maindomainurl

string

Filter to the specified main domain URL.

name

string

To get details for a specific object, using its name.

ownerid

string

Filter to the specified owner ID.

samlid

string

Filter to the specified SAML ID.

apikey

string

Filter to the specified mPulse API key.

Headers

Authorization

string

Alternative authorization methods. Options are Basic authentication or Bearer using the API Key listed in Account Settings. See Get started for help initially running the API.

X-Auth-Token

string

required

All calls to this API require that you pass in the token you get from the Generate a token operation as an X-Auth-Token request header. See Get started for help to initially call the API.

X-Tenant-Name

string

Optional, for use with the X-Auth-Token authorization header. The name of the tenant to connect to. Must be a tenant the user account has access to.

Responses

Response body

object

Repository objects.

objects

array of objects

required

Repository objects.

objects*

object

Repository object.

attributes

array of objects

required

Type-specific attributes (required for some object types). For example, the user type includes the attributes fullName, emailAddress, and password. Different types have different sets of attributes.

attributes*

object

name

string

Object attribute name.

value

string

Object attribute value.

body

string

required

The XML body, required for all object types. You can get the XML body from an existing object by exporting it from the mPulse UI.

created

string

required

Object creation date.

deleted

boolean

required

Whether or not the object has been deleted.

effectivePermissions

object

required

Effective permissions of the user on the object.

hidden

boolean

required

Whether or not the object is hidden.

integer

required

The unique ID of the newly created object.

lastModified

date-time

required

Last modified date.

name

string

required

Defaults to akamai.com

The object name.

ownerID

integer

required

Owner object ID.

readOnly

boolean

required

Whether or not the object is read-only.

references

array of objects

required

Reference object data.

references*

object

embedded

boolean

Whether or not this is an embedded reference.

number

Reference ID.

internalID

string

Reference internal ID.

name

string

Reference name.

path

string | null

Reference path.

type

string

Reference type.

schemaVersion

integer

required

The mPulse repository schema version.

tenantID

integer

required

Tenant ID.

type

string

enum

required

Defaults to domain

The mPulse object type.

alert dashboard domain tenant user

Language

Authentication

Remember to add your authentication token to run this code.


xxxxxxxxxx
1
curl --request GET \
2
     --url https://mpulse.soasta.com/concerto/services/rest/RepositoryService/v1/Objects/alert \
3
     --header 'accept: application/json'


xxxxxxxxxx
52
}
1
{
2
  "objects": [
3
    {
4
      "attributes": [
5
        {
6
          "name": "domain",
7
          "value": "akamai.com"
8
        },
9
        {
10
          "name": "apiKey",
11
          "value": "XXXXX-YYYYY-ZZZZZ-XXXXX-YYYYY"
12
        }
13
      ],
14
      "body": "<Domain xmlns=\"http://www.soasta.com/services/repository\"></Domain>",
15
      "created": "2022-01-01T00:00:00.000+0000",
16
      "deleted": false,
17
      "effectivePermissions": {
18
        "fullControl": true,
19
        "read": true,
20
        "use": true,
21
        "write": true
22
      },
23
      "hidden": false,
24
      "id": 10000,
25
      "lastModified": "2022-01-01T00:00:00.000+0000",
26
      "name": "akamai.com",
27
      "ownerID": 400000,
28
      "readOnly": false,
29
      "references": [
30
        {
31
          "embedded": false,
32
          "id": 1,
33
          "internalID": "rsdb",
34
          "name": "Local database",
35
          "path": null,
36
          "type": "resultsdatabase"
37
        },
38
        {
39
          "embedded": false,
40
          "id": 10000,
41
          "internalID": "boomr",
42
          "name": "boomerang-1.737.0",
43
          "path": null,
44
          "type": "boomerang"
45
        }
46
      ],
47
      "schemaVersion": 11000,
48
      "tenantID": 200000,
49
      "type": "domain"

200Success. Contains a list of repository objects, filtered by attributes.

400Bad request. The request may contain an invalid parameter or a required parameter has been omitted.