getPRForDashboard

GET /api/dashboard/stats/periodic-review/detail

getPRForDashboard

cURL

curl --request GET \
  --url https://api.artemis.cynopsis.co/api/dashboard/stats/periodic-review/detail \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'

import requests

url = "https://api.artemis.cynopsis.co/api/dashboard/stats/periodic-review/detail"

headers = {
    "X-Domain-ID": "<x-domain-id>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Domain-ID': '<x-domain-id>', Authorization: 'Bearer <token>'}
};

fetch('https://api.artemis.cynopsis.co/api/dashboard/stats/periodic-review/detail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.artemis.cynopsis.co/api/dashboard/stats/periodic-review/detail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "X-Domain-ID: <x-domain-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.artemis.cynopsis.co/api/dashboard/stats/periodic-review/detail"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Domain-ID", "<x-domain-id>")
	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.artemis.cynopsis.co/api/dashboard/stats/periodic-review/detail")
  .header("X-Domain-ID", "<x-domain-id>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.artemis.cynopsis.co/api/dashboard/stats/periodic-review/detail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Domain-ID"] = '<x-domain-id>'
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "items": [
    {
      "active": true,
      "assignees": [
        {
          "email": "<string>",
          "firstName": "<string>",
          "fullName": "<string>",
          "id": 123,
          "lastName": "<string>"
        }
      ],
      "createdAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      },
      "forms": {},
      "id": 123,
      "lastRiskAssessment": "2023-11-07T05:31:56Z",
      "listRoleAsText": [
        "<string>"
      ],
      "notes": {},
      "other": {},
      "parentId": 123,
      "particular": {},
      "profileId": 123,
      "profileReferenceId": "<string>",
      "referenceId": "<string>",
      "roles": [
        {
          "appointedDate": "2023-12-25",
          "createdAt": {
            "date": 123,
            "day": 123,
            "hours": 123,
            "minutes": 123,
            "month": 123,
            "nanos": 123,
            "seconds": 123,
            "time": 123,
            "timezoneOffset": 123,
            "year": 123
          },
          "createdBy": {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          },
          "id": 123,
          "resignedDate": "2023-12-25",
          "role": "<string>",
          "updatedAt": {
            "date": 123,
            "day": 123,
            "hours": 123,
            "minutes": 123,
            "month": 123,
            "nanos": 123,
            "seconds": 123,
            "time": 123,
            "timezoneOffset": 123,
            "year": 123
          },
          "updatedBy": {
            "email": "<string>",
            "firstName": "<string>",
            "fullName": "<string>",
            "id": 123,
            "lastName": "<string>"
          }
        }
      ],
      "updatedAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      },
      "vendorEntityGuid": "<string>",
      "vendorName": "<string>"
    }
  ],
  "nextToken": "<string>",
  "total": 123
}

Authorizations

OAuth2_Client_CredentialsOAuth2_Password

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Domain-ID · integer<int64> · required

X-Domain-ID

Query Parameters

authority · string

claims · object

domains[0].id · integer<int64>

domains[0].name · string

email · string

endDate · string<date>

endDate

headers · object

nextToken · string

nextToken

pageSize · integer<int32> · default: 10

pageSize

scopes · string

startDate · string<date>

startDate

tokenValue · string

userId · string

Response

200

*/*

OK

items · CustomerResponseDto · object[]

Show child attributes

nextToken · string

total · integer<int64>