Gets a catalog by ID for the current user.

get https://{baseUrl}/api/catalogues/getCatalogWithAllDetails/{id}

If the catalog has no security control parameters, security control implementation
options, or security control objectives, those lists will be empty.

time	status	user agent
Retrieving recent requests…

Loading…

Responses

Response body

object

catalog

object

createdBy

string | null

lastUpdatedBy

string | null

int32

createdById

string | null

dateCreated

date-time | null

lastUpdatedById

string | null

dateLastUpdated

date-time | null

isPublic

boolean

uuid

string | null

title

string

required

length ≥ 1

description

string | null

datePublished

date-time | null

lastRevisionDate

date-time | null

externalId

string | null

originator

int32

10

regulationDatePublished

date-time | null

regulationDateModified

date-time | null

url

string | null

sourceOscalURL

string | null

abstract

string | null

keywords

string | null

master

boolean

defaultName

string | null

downloadURL

string | null

requireUniqueControlId

boolean

category

string | null

controls

array of objects | null

controls

object

createdBy

string | null

lastUpdatedBy

string | null

int32

createdById

string | null

dateCreated

date-time | null

lastUpdatedById

string | null

dateLastUpdated

date-time | null

isPublic

boolean

uuid

string | null

controlId

string | null

sortId

string | null

controlType

string | null

title

string | null

description

string | null

references

string | null

relatedControls

string | null

subControls

string | null

enhancements

string | null

family

string | null

mappings

string | null

assessmentPlan

string | null

weight

double

catalogueId

int32

practiceLevel

string | null

otherId

string | null

criticality

string | null

parameters

array of objects | null

parameters

object

int32

uuid

string | null

text

string

required

length ≥ 1

dataType

string | null

default

string | null

displayName

string | null

parameterId

string

required

length ≥ 1

securityControlId

int32

guidance

string | null

constraints

string | null

otherId

string | null

createdBy

string | null

createdById

string | null

dateCreated

date-time | null

lastUpdatedBy

string | null

lastUpdatedById

string | null

dateLastUpdated

date-time | null

options

array of objects | null

options

object

int32

uuid

string | null

name

string

required

length ≥ 1

description

string

required

length ≥ 1

acceptability

string

required

length ≥ 1

otherId

string | null

securityControlId

int32 | null

objectiveId

int32 | null

restricted

boolean

restrictedSecurityPlanId

int32 | null

archived

boolean

deprecated

createdBy

string | null

createdById

string | null

dateCreated

date-time | null

lastUpdatedBy

string | null

lastUpdatedById

string | null

dateLastUpdated

date-time | null

objectives

array of objects | null

objectives

object

int32

createdBy

string | null

createdById

string | null

dateCreated

date-time | null

lastUpdatedBy

string | null

lastUpdatedById

string | null

dateLastUpdated

date-time | null

uuid

string | null

name

string

required

length ≥ 1

description

string

required

length ≥ 1

objectiveType

string | null

otherId

string | null

securityControlId

int32

parentObjectiveId

int32 | null

externalMappings

array of objects | null

externalMappings

object

int32

createdBy

string | null

createdById

string | null

dateCreated

date-time | null

lastUpdatedBy

string | null

lastUpdatedById

string | null

isPublic

boolean

uuid

string | null

parentControlId

int32

controlId

string | null

title

string | null

catalog

string | null

mappingType

string | null

notes

string | null

dateLastUpdated

date-time | null

400

The operation wasn't successful; the body of the response contains details.

401

(1) The caller is not authenticated with RegScale.

(2) The caller does not have the following roles: Administrator, GeneralUser, Manager, SecurityPlanUser,
Maintainer, ReadOnly.

(3) The caller does not have access rights.

404

The catalog could not be found.

No security controls could be found the the given catalog.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://your-instance.regscale.co/api/catalogues/getCatalogWithAllDetails/id \
3
     --header 'accept: application/json'


xxxxxxxxxx
138
}
1
{
2
  "catalog": {
3
    "createdBy": "string",
4
    "lastUpdatedBy": "string",
5
    "id": 0,
6
    "createdById": "string",
7
    "dateCreated": "2025-04-19T21:10:16.088Z",
8
    "lastUpdatedById": "string",
9
    "dateLastUpdated": "2025-04-19T21:10:16.088Z",
10
    "isPublic": true,
11
    "uuid": "string",
12
    "title": "string",
13
    "description": "string",
14
    "datePublished": "2025-04-19T21:10:16.088Z",
15
    "lastRevisionDate": "2025-04-19T21:10:16.088Z",
16
    "externalId": "string",
17
    "originator": 0,
18
    "regulationDatePublished": "2025-04-19T21:10:16.088Z",
19
    "regulationDateModified": "2025-04-19T21:10:16.088Z",
20
    "url": "string",
21
    "sourceOscalURL": "string",
22
    "abstract": "string",
23
    "keywords": "string",
24
    "master": true,
25
    "defaultName": "string",

200The catalog model for the given catalog ID.