All pages
Powered by GitBook
1 of 1

Loading...

List spotlight objects

Gets a list of spotlight result objects for the specified account (retrieved from JWT) and the buyer group (retrieved from the API for the requesting user), filtered by an RQL query if applicable.

get
Responses
200

OK

application/json
offsetinteger · int32Optional
limitinteger · int32Optional
totalinteger · int32 · nullableOptional
omittedstring[]Optional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
createdall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
updatedall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
omittedstring[]Optional
totalinteger · int32Optional
itemsanyOptional
idstringOptional
atstring · date-time · nullableOptional
idstringOptional
createdall ofOptional
⤷Circular reference to all of
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
atstring · date-time · nullableOptional
idstringOptional
atstring · date-time · nullableOptional
byall ofOptional
⤷Circular reference to all of
updatedall ofOptional
⤷Circular reference to all of
omittedstring[]Optional
namestringOptional
iconstring · nullableOptional
omittedstring[]Optional
namestringOptional
templatestringOptional
intervalstring · date-spanOptional
filterstringOptional
scopestring · enumOptionalPossible values:
namestring · nullableOptional
get/public/v1/spotlight/objects
GET /public/v1/spotlight/objects HTTP/1.1
Host: api.platform.softwareone.com
Accept: */*
200

OK

{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {},
        "updated": {}
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "total": 1,
      "top": [],
      "query": {
        "id": "text",
        "audit": {},
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "template": "text",
        "invalidation": {
          "interval": "text"
        },
        "filter": "text",
        "scope": "text"
      },
      "name": "text"
    }
  ]
}