---
title: "GET /Form/{publicId}"
method: GET
path: "/Form/{publicId}"
---

# GET /Form/{publicId}

`GET /Form/{publicId}`

## Request

- Base URL: `https://cadsrapi.cancer.gov/rad/NCIFormAPI.v1_0:NciFormApiRad`
- URL: `https://cadsrapi.cancer.gov/rad/NCIFormAPI.v1_0:NciFormApiRad/Form/{publicId}`
- Auth: none declared
- TypeScript: <https://skmtc.dev/cancer/apis/nci-form-api/docs/Form/:publicId/get.ts> (a function with typed inputs; its response is checked against the schema)

GET a particular Form object.
Examples:
• To get a form object and version with publicID of 5406471 and version 1:
 /Form/5406471?version=1
• Note: if a version is not provided, the latest version will be returned.

## Path parameters

- `publicId` string, required

## Query parameters

- `version` string

## Response `200`

OK

- FormpublicIdGETResponse
  - `Form` Form
    - `publicID` string, required: The unique identifier for an Administered Item within a Registration Authority.
    - `version` string, required: The unique version identifier of the Administered Item.
    - `longName` string: A 255 character limit name for an item in the registry.
    - `context` string: An associated gov.nih.nci.cadsr.domain.Context object
    - `latestVersionIndicator` string: The present form of an Administered Item.
    - `type` string: The type of form.
    - `definition` string: The text of the most desirable meaning for the Administered Item.
    - `beginDate` string: The particular day, month and year this item became allowed.
    - `changeNote` string: The description of what has changed in the Administered Item since the prior version of the Administered Item.
    - `createdBy` string: Username of the person who created the record
    - `dateCreated` string: The date the Administered Item was created.
    - `dateModified` string: Date on which the record was modified; last date the object was modified
    - `deletedIndicator` string: An indicator that characterizes the item as eliminated from the registry, thought the physical record still exists.
    - `endDate` string: The day, month and year this item becomes no longer allowed.
    - `modifiedBy` string: Username of the person who modified the record
    - `preferredDefinition` string: The text of the most desirable meaning for the Administered Item.
    - `category` string
    - `registrationStatus` string: A designation of the status in the registration life-cycle of an Administered Item.
    - `administrativeNotes` string: Any problem that remains unresolved regarding proper documentation of the Administered Item.
    - `unresolvedIssues` string
    - `workflowStatus` string: A name of a designation of the status in the administrative life-cycle of a Context Owner for handling new administered items.
    - `classificationSchemes` ClassificationScheme[], required
      - `publicId` string, required: The unique identifier for an Administered Item within a Registration Authority.
      - `version` string, required
      - `longName` string, required
      - `context` string, required
      - `ClassificationSchemeItems` ClassificationSchemeItem[]
        - `publicId` string, required: The unique identifier for an Administered Item within a Registration Authority.
        - `version` string, required
        - `longName` string, required
        - `context` string, required
    - `modules` Module[], required
      - `longName` string, required: A 255 character limit name for an item in the registry.
      - `displayOrder` string, required: The logical arrangement of items for viewing in a user interface.
      - `maximumQuestionRepeat` string, required: The maximum number of times a question may repeat within a module
      - `publicID` string, required: The unique identifier for an Administered Item within a Registration Authority.
      - `version` string, required: The unique version identifier of the Administered Item.
      - `questions` Question[], required
        - `displayOrder` string, required: The logical arrangement of items for viewing in a user interface.
        - `defaultValue` string, required: default value for the question when it is non enumerated
        - `isEditable` string, required: Is the default valid value editable
        - `isMandatory` string, required: Is the question mandatory
        - `questionShortName` string, required
        - `questionText` string, required
        - `dataElement` DataElement[], required
          - `beginDate` string, required: The particular day, month and year this item became allowed.
          - `changeNote` string, required: The description of what has changed in the Administered Item since the prior version of the Administered Item.
          - `createdBy` string, required: Username of the person who created the record
          - `dateCreated` string, required: The date the Administered Item was created.
          - `dateModified` string, required: Date on which the record was modified; last date the object was modified
          - `deletedIndicator` string, required: An indicator that characterizes the item as eliminated from the registry, thought the physical record still exists.
          - `endDate` string, required: The day, month and year this item becomes no longer allowed.
          - `latestVersionIndicator` string, required: The present form of an Administered Item.
          - `longName` string, required: A 255 character limit name for an item in the registry.
          - `modifiedBy` string, required: Username of the person who modified the record
          - `publicID` string, required: The unique identifier for an Administered Item within a Registration Authority.
          - `version` string, required: The unique version identifier of the Administered Item.
          - `shortName` string, required: A 30 character name by which an Administered Item is designated within a specific Context.
          - `preferredDefinition` string, required: The text of the most desirable meaning for the Administered Item.
          - `origin` string, required: The source (document, project, discipline or model) for the Administered Item.
          - `referenceDocuments` ReferenceDocument[], required
            - `name` string, required: The words by which the item is known.
            - `type` string, required: The particular type of reference document.
            - `docText` string, required: The description of the reference document.
            - `context` string, required: An associated gov.nih.nci.cadsr.domain.Context object
            - `url` string, required: A Uniform Resource Locator is an Internet address which tells a browser where to find an Internet resource.
          - `designations` Designation[], required
            - `name` string, required: The words by which an item is known.
            - `type` string, required: A particular kind of designation.
            - `language` string, required: The name of the language in which the item is represented.
            - `contextName` string, required: An associated gov.nih.nci.cadsr.domain.Context object
        - `instructions` Instruction[], required
          - `instruction` string, required: An instruction.
        - `valueDomain` ValueDomain[], required
          - `beginDate` string, required: The particular day, month and year this item became allowed.
          - `changeNote` string, required: The description of what has changed in the Administered Item since the prior version of the Administered Item.
          - `createdBy` string, required: Username of the person who created the record
          - `dateCreated` string, required: The date the Administered Item was created.
          - `dateModified` string, required: Date on which the record was modified; last date the object was modified
          - `deletedIndicator` string, required: An indicator that characterizes the item as eliminated from the registry, thought the physical record still exists.
          - `endDate` string, required: The day, month and year this item becomes no longer allowed.
          - `latestVersionIndicator` string, required: The present form of an Administered Item.
          - `longName` string, required: A 255 character limit name for an item in the registry.
          - `modifiedBy` string, required: Username of the person who modified the record
          - `publicID` string, required: The unique identifier for an Administered Item within a Registration Authority.
          - `version` string, required: The unique version identifier of the Administered Item.
          - `preferredDefinition` string, required: The text of the most desirable meaning for the Administered Item.
          - `preferredName` string, required: A 30 character limit name by which an Administered Item is designated within a specific Context.
          - `datatypeName` string, required: The words by which the datatype for an item is known.
          - `decimalPlace` string, required: An indication of the specific number of digits to be expected to the right of the decimal point in a line of numbers.
          - `formatName` string, required: The words by which a template for the structure of the presentation of the Value(s) is known.
          - `highValueNumber` string, required: The upper limit of a range
          - `lowValueNumber` string, required: The lower limit of a range
          - `maximumLengthNumber` string, required: The maximum number of characters to represent the Data Element value.
          - `minimumLengthNumber` string, required: The minimum number of characters to represent the Data Element value.
          - `UOMName` string, required: The name of the actual units in which the associated values are measured.
          - `context` string, required: An associated gov.nih.nci.cadsr.domain.Context object
          - `origin` string, required: The source (document, project, discipline or model) for the Administered Item.
          - `triggerActions` TriggerAction[], required
            - `sourcePUB_ID` string, required
            - `sourceVER_NR` string, required
            - `source` string, required
            - `sourceModule` string, required
            - `sourceQuestion` string, required
            - `sourceValidValue` string, required
            - `targetPUB_ID` string, required
            - `targetVER_NR` string, required
            - `target` string, required
            - `targetModule` string, required
            - `targetQuestion` string, required
            - `targetValidValue` string, required
            - `dateCreated` string, required
            - `createdBy` string, required
            - `modifiedBy` string, required
            - `dateModified` string, required
            - `deletedIndicator` string, required
            - `triggerActionId` string, required
            - `instructions` Instruction, required
              - …
          - `permissibleValues` PermissibleValue[], required
            - `validValue` string, required: A representation of a Value Meaning in a specific Value Domain the actual Value.
            - `valueMeaning` string, required: An associated gov.nih.nci.cadsr.domain.ValueMeaning object
            - `meaningDescription` string, required: A statement in words representing the item.
            - `meaningConcepts` string, required
            - `meaningConceptOrigin` string, required
            - `meaningConceptDisplayOrder` string, required
            - `beginDate` string, required: The particular day, month and year this item became allowed.
            - `endDate` string, required: The day, month and year this item becomes no longer allowed.
            - `publicID` string, required: The unique identifier for an Administered Item within a Registration Authority.
            - `version` string, required: The unique version identifier of the Administered Item.
        - `validValues` ValidValues[], required
          - `value` string, required: A valid value.
          - `description` string, required: the description associated with the valid value
          - `dipslayOrder` string, required: The logical arrangement of items for viewing in a user interface.
          - `meaningText` string, required: the meaning associated with the valid value
          - `publicId` string, required: The public ID of the valid value.
          - `version` string, required: The version of the valid value.
          - `valueMeaning` ValueMeaning, required
            - `publicID` string, required: The unique identifier for an Administered Item within a Registration Authority.
            - `version` string, required: The unique version identifier of the Administered Item.
            - `meaningConcepts` string
            - `meaningConceptOrigin` string
            - `meaningConceptDisplayOrder` string
            - `longName` string
            - `preferredDefinition` string
          - `instructions` Instruction[], required
            - `instruction` string, required: An instruction.
          - `triggerActions` TriggerAction[], required
            - `sourcePUB_ID` string, required
            - `sourceVER_NR` string, required
            - `source` string, required
            - `sourceModule` string, required
            - `sourceQuestion` string, required
            - `sourceValidValue` string, required
            - `targetPUB_ID` string, required
            - `targetVER_NR` string, required
            - `target` string, required
            - `targetModule` string, required
            - `targetQuestion` string, required
            - `targetValidValue` string, required
            - `dateCreated` string, required
            - `createdBy` string, required
            - `modifiedBy` string, required
            - `dateModified` string, required
            - `deletedIndicator` string, required
            - `triggerActionId` string, required
            - `instructions` Instruction, required
              - …
        - `triggerActions` TriggerAction[], required
          - `sourcePUB_ID` string, required
          - `sourceVER_NR` string, required
          - `source` string, required
          - `sourceModule` string, required
          - `sourceQuestion` string, required
          - `sourceValidValue` string, required
          - `targetPUB_ID` string, required
          - `targetVER_NR` string, required
          - `target` string, required
          - `targetModule` string, required
          - `targetQuestion` string, required
          - `targetValidValue` string, required
          - `dateCreated` string, required
          - `createdBy` string, required
          - `modifiedBy` string, required
          - `dateModified` string, required
          - `deletedIndicator` string, required
          - `triggerActionId` string, required
          - `instructions` Instruction, required
            - `instruction` string, required: An instruction.
      - `instructions` Instruction[], required
        - `instruction` string, required: An instruction.
      - `referenceDocuments` ReferenceDocument[], required
        - `name` string, required: The words by which the item is known.
        - `type` string, required: The particular type of reference document.
        - `docText` string, required: The description of the reference document.
        - `context` string, required: An associated gov.nih.nci.cadsr.domain.Context object
        - `url` string, required: A Uniform Resource Locator is an Internet address which tells a browser where to find an Internet resource.
      - `triggerActions` TriggerAction[], required
        - `sourcePUB_ID` string, required
        - `sourceVER_NR` string, required
        - `source` string, required
        - `sourceModule` string, required
        - `sourceQuestion` string, required
        - `sourceValidValue` string, required
        - `targetPUB_ID` string, required
        - `targetVER_NR` string, required
        - `target` string, required
        - `targetModule` string, required
        - `targetQuestion` string, required
        - `targetValidValue` string, required
        - `dateCreated` string, required
        - `createdBy` string, required
        - `modifiedBy` string, required
        - `dateModified` string, required
        - `deletedIndicator` string, required
        - `triggerActionId` string, required
        - `instructions` Instruction, required
          - `instruction` string, required: An instruction.
    - `protocols` Protocol[], required
      - `protocolId` string, required: The set of characters used to identify this Protocol.
      - `longName` string, required: A 255 character limit name for an item in the registry.
      - `organizationName` string, required: The organization in charge of this Protocol.
      - `beginDate` string, required: The particular day, month and year this item became allowed.
      - `changeNote` string, required: The description of what has changed in the Administered Item since the prior version of the Administered Item.
      - `createdBy` string, required: Username of the person who created the record
      - `dateCreated` string, required: The date the Administered Item was created.
      - `dateModified` string, required: Date on which the record was modified; last date the object was modified
      - `deletedIndicator` string, required: An indicator that characterizes the item as eliminated from the registry, thought the physical record still exists.
      - `endDate` string, required: The day, month and year this item becomes no longer allowed.
      - `id` string, required: The 36 character caDSR database identifier.
      - `modifiedBy` string, required: Username of the person who modified the record
      - `origin` string, required: The source (document, project, discipline or model) for the Administered Item.
      - `preferredDefinition` string, required: The text of the most desirable meaning for the Administered Item.
      - `preferredName` string, required: A 30 character limit name by which an Administered Item is designated within a specific Context.
      - `publicID` string, required: The unique identifier for an Administered Item within a Registration Authority.
      - `version` string, required: The unique version identifier of the Administered Item.
      - `latestVersionIndicator` string, required: The present form of an Administered Item.
    - `instructions` Instruction[], required
      - `instruction` string, required: An instruction.
    - `referenceDocuments` ReferenceDocument[], required
      - `name` string, required: The words by which the item is known.
      - `type` string, required: The particular type of reference document.
      - `docText` string, required: The description of the reference document.
      - `context` string, required: An associated gov.nih.nci.cadsr.domain.Context object
      - `url` string, required: A Uniform Resource Locator is an Internet address which tells a browser where to find an Internet resource.
    - `triggerActions` TriggerAction[], required
      - `sourcePUB_ID` string, required
      - `sourceVER_NR` string, required
      - `source` string, required
      - `sourceModule` string, required
      - `sourceQuestion` string, required
      - `sourceValidValue` string, required
      - `targetPUB_ID` string, required
      - `targetVER_NR` string, required
      - `target` string, required
      - `targetModule` string, required
      - `targetQuestion` string, required
      - `targetValidValue` string, required
      - `dateCreated` string, required
      - `createdBy` string, required
      - `modifiedBy` string, required
      - `dateModified` string, required
      - `deletedIndicator` string, required
      - `triggerActionId` string, required
      - `instructions` Instruction, required
        - `instruction` string, required: An instruction.
  - `apiResponse` ApiResponse, required
    - `type` string, required: S Success, E Error, W Warning, I Info, A Abort
    - `message` string: Message text
    - `service` string: service that errorred
    - `time` string: Date and time of error
    - `ssnid` string: session id
    - `callStack` CallstackItem[]
      - `service` string, required
      - `flowStep` string, required

## Other responses

- `401`: Access Denied

---

[API](https://skmtc.dev/cancer/apis/nci-form-api.md) - [All operations](https://skmtc.dev/cancer/apis/nci-form-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cancer/apis/nci-form-api/revisions/ab59f27f2139?raw)