Versions Compared

Old Version 1

changes.mady.by.user Kaustubh Wadagavi

Saved on

compared with

New Version 2

changes.mady.by.user Kaustubh Wadagavi

Saved on

Key

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

openspecimen/rest/ng/permissible-values/

Use this resource URL to create a PV dropdown value.

attribute

A unique name of dropdown where you are adding a new value.

Props

Properties of dropdown. e.g., {"abbreviation": "cDNA"}

Value

A unique dropdown value.

Concept Code

A unique concept code

http[s]:<host>:<port>/openspecimen/rest/ng/permissible-values/

Use this URL to add to create a new PV dropdown.

Result:

The response to this request will contain the details of the added new PV dropdown.

Below is an example of adding a PV dropdown:

URL

http[s]:<host>:<port>/openspecimen/rest/ng/permissible-values/

Method

POST

Request

application/json

Request Payload

Code Block
{
    "attribute": "spsz",
    "props": {
        "abbreviation": "5mmx5mm"
    },
    "value": "5*5mm",
    "conceptCode": "size in mm"
}

Response

Code Block
{
    "id": 91621,
    "value": "5*5mm",
    "attribute": "spsz",
    "conceptCode": "size in mm",
    "props": {
        "abbreviation": "5mmx5mm"
    },
    "activityStatus": "Active"
}

code

Applies to

Status Message

200

All resources

Collection Protocol Event has been created successfully

400

All requests

Invalid parameters, e.g  duplicate event label, blank event label etc

401

All requests

Authorization failed, user doesn’t have authority

500

All requests

Internal server error, encountered server error while performing operations