DQM-website

The DQM Website API calls provide information relating to websites setup within your DQM instance.

GET groups websites

https://api.crownpeak.net/dqm-website/v1/groups/:groupId/websites?clientId=5678&visibility=public

Returns a list of websites for the specified Group. To return all websites use ALL_WEBSITES for the groupId parameter.

 

Headers

Authorization

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5cBearer token from DQM-security

 

Params

clientId	5678 The required client ID for the website.
visibility	One of either: public|restricted

 

Path Variables

groupId

1234 The id of the group for which you want a list of websites or 'ALL_WEBSITES' to which you have access

 

Example Request

curl --location --request GET 'https://api.crownpeak.net/dqm-website/v1/groups/ALL_WEBSITES/websites?clientId=5678' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c'

 

Example Response (body)

{
  "websites": [
    {
      "id": "123",
      "name": "A website"
    },
    {
      "id": "456",
      "name": "Another website"
    },
    {
      "id": "789",
      "name": "Yet Another Website"
    }
  ]
}

 

Example Response (Headers)

Content-Encoding: gzip
Content-Length: 694
Content-Type: application/json; charset=UTF-8
Date: Thu, 12 Jul 2018 18:55:14 GMT
Server: spray-can/1.3.3