Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Info

The primary purpose of these response examples is to show users how values may appear in the response data structure, in JSON or XML format. These examples are illustrations only and not representative of actual CDISC standards and their metadata.

Step-by-step guide

StepInstructionNotes
1Go to the CDISC Library API
Documentation web page
Portal: https://
www
api.developer.library.cdisc.org/api-details#api=cdisc-library
/
-api
-documentation.
  • An
CDISC.org account
  • cdiscID is required. To self-register one,
visit 
user/registration
2Click on an endpoint to expand for Parameters and Responses.
  • A horizontal blue bar indicates an API endpoint. Each API endpoint has a Parameters and a Responses section.
  • Expand
    titleScreenshot of example endpoints...

    Image Modified

  • Not all API endpoints have parameter specifications.
  • Expand
    titleScreenshot of example endpoints with and without parameters...

    Image Modified

    Image Modified

  • A parameter may be path or query type. See Swagger's API Host and Base URL for detailed explanations.
  • For example, Get CDISC Library CT Package has specifications for both parameter and response.
3Scroll down to the Parameters section. Where parameters are applicable to an API endpoint, an example value will appear for each named parameter.
4Scroll down to the Responses where Code is 200, example response for the corresponding API endpoint appears under Example Value.
Expand
titleScreenshot...

Image Modified

5Select the Media Type to view examples in the corresponding data format.
Expand
titleScreenshot...

Image Modified

Content by Label
showLabelsfalse
max5
spacesLIBSUPRT
showSpacefalse
sortmodified
reversetrue
typepage
cqllabel in ("kb-how-to-article","kb-minute-article") and type = "page" and space = "LIBSUPRT"
labelskb-how-to-article

...