Jump to

• Request
• Response

Get library uses by study ID and version

get

/ec-library-svc/rest/v2.0/libraryUses/studies/{studyId}/versions/{studyVersion}

Retrieves library uses for a particular study ID and version.

Request

Path Parameters

• studyId(required): string(uuid)
  The study id
• studyVersion(required): string
  The study version

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object LibraryUsesDto v2.0
  Title: LibraryUsesDto v2.0

  Information about library uses

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/LibraryUsesDtoV2"
    }
}

Nested Schema : LibraryUsesDto v2.0

Type: object

Title: LibraryUsesDto v2.0

Information about library uses

Show Source

• libraryId: string (uuid)
  Library ID
• librarySourceStudyId: string (uuid)
  Study id where library was created
• objectId: string (uuid)
  Object (forms...) ID
• objectType: string
  Object type

  Example: FORM
• relationType: string
  Allowed Values: [ "LIBRARY_ROOT, IMPORT_FROM_LIBRARY, IMPORT_FROM_LIBRARY_MODIFIED" ]

  Uses relation type

  Example: LIBRARY_ROOT
• status: string
  Study type

  Example: LIBRARY
• studyId: string (uuid)
  Study id
• studyVersion: string (uuid)
  Library study version
• versionStart: string (date-time)
  Uses version start - last modified

{
    "title":"LibraryUsesDto v2.0",
    "type":"object",
    "properties":{
        "libraryId":{
            "type":"string",
            "description":"Library ID",
            "format":"uuid"
        },
        "objectId":{
            "type":"string",
            "description":"Object (forms...) ID",
            "format":"uuid"
        },
        "objectType":{
            "type":"string",
            "description":"Object type",
            "example":"FORM"
        },
        "status":{
            "type":"string",
            "description":"Study type",
            "example":"LIBRARY"
        },
        "studyId":{
            "type":"string",
            "description":"Study id",
            "format":"uuid"
        },
        "studyVersion":{
            "type":"string",
            "description":"Library study version",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Uses version start - last modified",
            "format":"date-time"
        },
        "relationType":{
            "type":"string",
            "description":"Uses relation type",
            "example":"LIBRARY_ROOT",
            "enum":[
                "LIBRARY_ROOT, IMPORT_FROM_LIBRARY, IMPORT_FROM_LIBRARY_MODIFIED"
            ]
        },
        "librarySourceStudyId":{
            "type":"string",
            "description":"Study id where library was created",
            "format":"uuid"
        }
    },
    "description":"Information about library uses"
}

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : details

Type: object

Back to Top