Jump to

• Request
• Response

v1.0

delete

/ec-library-svc/rest/v1.0/libraryUses

Deletes library uses for particular object and study versions.

Request

Query Parameters

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

  Example:

  B1B8327AFAA6412287106192AB5984EF

• studyId(required): string(uuid)
  Unique identifier (UUID, 32-character uppercase hexadecimal string) representing the study.

  Example:

  B1B8327AFAA6412287106192AB5984EF

• studyVersion(required): string
  Study version

  Example:

  1.0.0.1

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

  Information about how a library object is used in studies.

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

Nested Schema : LibraryUsesDtoV1.0

Type: object

Title: LibraryUsesDtoV1.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
• 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
• 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

{
    "title":"LibraryUsesDtoV1.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"
        }
    },
    "description":"Information about how a library object is used in studies."
}

Examples

Select an example LibraryUsesDeleteResponseV1

500 Response

Error

Body ()

Root Schema : ErrorResponseData

Type: object

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information."
        }
    },
    "description":"Error Response Details Information"
}

Nested Schema : Object

Type: object

Title: Object

Object with error details information.

Back to Top