Jump to

• Request
• Response

v2.0

get

/ec-library-svc/rest/v2.0/libraryUses/library/{libraryId}/studyType/{studyType}

Retrieves all library uses for a given library object and study type, for study types it was imported to.

Request

Path Parameters

• libraryId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.

  Example:

  B1B8327AFAA6412287106192AB5984EF

• studyType(required): string
  Study type

  Example:

  LIBRARY

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 LibraryUsesDtoV2.0
  Title: LibraryUsesDtoV2.0

  Information about how a library object is used in studies.

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

Nested Schema : LibraryUsesDtoV2.0

Type: object

Title: LibraryUsesDtoV2.0

Information about how a library object is used in studies.

Show Source

• libraryId: string
  Title: Library ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.

  Example: B1B8327AFAA6412287106192AB5984EF
• librarySourceStudyId: string
  Title: Library source study ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of source study where the library was created.

  Example: B1B8327AFAA6412287106192AB5984EF
• objectId: string
  Title: Object ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the underlying object (for example, forms or rules).

  Example: B1B8327AFAA6412287106192AB5984EF
• objectType: string
  Title: Object type

  Type of the underlying object.

  Example: FORM
• relationType: string
  Title: Relation type

  Allowed Values: [ "LIBRARY_ROOT, IMPORT_FROM_LIBRARY, IMPORT_FROM_LIBRARY_MODIFIED" ]

  Relationship type describing how the library object is used.

  Example: LIBRARY_ROOT
• studyId: string
  Title: Study ID

  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example: B1B8327AFAA6412287106192AB5984EF
• studyType: string
  Title: Study type

  Type of the study.

  Example: LIBRARY
• studyVersion: string
  Title: Study version

  String representing the version of the study configuration or protocol. Helps track changes in form or study design.

  Example: 1.0.0.1
• versionStart: string (date-time)
  Title: Version start

  Uses version start timestamp.

  Example: 2023-08-30T07:59:46.901Z

{
    "title":"LibraryUsesDtoV2.0",
    "type":"object",
    "properties":{
        "libraryId":{
            "title":"Library ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the library object.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "objectId":{
            "title":"Object ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the underlying object (for example, forms or rules).",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "objectType":{
            "title":"Object type",
            "type":"string",
            "description":"Type of the underlying object.",
            "example":"FORM"
        },
        "studyType":{
            "title":"Study type",
            "type":"string",
            "description":"Type of the study.",
            "example":"LIBRARY"
        },
        "studyId":{
            "title":"Study ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        },
        "studyVersion":{
            "title":"Study version",
            "type":"string",
            "description":"String representing the version of the study configuration or protocol. Helps track changes in form or study design.",
            "example":"1.0.0.1"
        },
        "versionStart":{
            "title":"Version start",
            "type":"string",
            "description":"Uses version start timestamp.",
            "format":"date-time",
            "example":"2023-08-30T07:59:46.901Z"
        },
        "relationType":{
            "title":"Relation type",
            "type":"string",
            "description":"Relationship type describing how the library object is used.",
            "example":"LIBRARY_ROOT",
            "enum":[
                "LIBRARY_ROOT, IMPORT_FROM_LIBRARY, IMPORT_FROM_LIBRARY_MODIFIED"
            ]
        },
        "librarySourceStudyId":{
            "title":"Library source study ID",
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of source study where the library was created.",
            "example":"B1B8327AFAA6412287106192AB5984EF"
        }
    },
    "description":"Information about how a library object is used in studies."
}

Examples

Select an example LibraryUsesByLibraryIdAndStudyTypeResponseV2

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