Jump to

• Request
• Response

Get all sites and depots details by study ID based on given filters

get

/ec-site-svc/rest/v1.0/studies/{studyId}/{mode}/sdfs/sdf/{sdfType}

Retrieves all sites and/or depots details for a given study and based on given parameters. If sdfType is all, then list all sites and depots for which user has access. If sdfType is Site, lists all sites for which user has access that match filter criteria. If sdfType is Depot, lists all depots details for which user has access.

Request

Path Parameters

• mode(required): string
  Mode of the study. Accepts active, test, or training.
• sdfType(required): string
  Type of SDF : Sites or Depots.
• studyId(required): string
  The ID of the study.

Query Parameters

• countryISOCode: string
  The ISO codes of the countries.
• countryId: string
  Country ID.
• excludeExtendedProperties: string
  Retrieve extended properties for site only if the excludeExtendedProperties flag is false.
• limit: integer(int32)
  Number of rows to return.
• name: string
  Name search filter for site
• offset: integer(int32)
  Row number to start from.
• order: string
  The Order in which the sites are returned.
• statusId: string
  Site Status filter
• studyVersion: string
  Study version filter for site
• supplyCountryId: string
  Supply Country ID.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation.

Body ()

Root Schema : SDFDetailsResponse

Type: object

Show Source

• sdf: object Discriminator: sdfType
  Discriminator: { "propertyName":"sdfType" }
• sdfAddressAssociations: array sdfAddressAssociations
• sdfKitSettingDto: array sdfKitSettingDto
• sdfPropertyList: array sdfPropertyList

{
    "type":"object",
    "properties":{
        "sdf":{
            "$ref":"#/components/schemas/SDFDetailsDto"
        },
        "sdfPropertyList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        },
        "sdfAddressAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFAddressAssociationDetailsDto"
            }
        },
        "sdfKitSettingDto":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFKitSettingDto"
            }
        }
    }
}

Nested Schema : Discriminator: sdfType

Type: object

{
    "required":[
        "sdfType"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "tenantEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "studyOrgIdName":{
            "type":"string"
        },
        "statusId":{
            "type":"string",
            "format":"uuid"
        },
        "statusIdCodeValue":{
            "type":"string"
        },
        "oldSdfId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfType":{
            "type":"string"
        }
    },
    "discriminator":{
        "propertyName":"sdfType"
    }
}

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• objectVersionNumber: number
• oldSdfId: string (uuid)
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfType(required): string
• softwareVersionNumber: number
• statusId: string (uuid)
• statusIdCodeValue: string
• studyOrgIdName: string
• tenantEntityId: string (uuid)
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "sdfType"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "tenantEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "studyOrgIdName":{
            "type":"string"
        },
        "statusId":{
            "type":"string",
            "format":"uuid"
        },
        "statusIdCodeValue":{
            "type":"string"
        },
        "oldSdfId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfType":{
            "type":"string"
        }
    },
    "discriminator":{
        "propertyName":"sdfType"
    }
}

Nested Schema : sdfAddressAssociations

Type: array

Show Source

• Array of: object SDFAddressAssociationDetailsDto

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

Nested Schema : sdfKitSettingDto

Type: array

Show Source

• Array of: object SDFKitSettingDto

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

Nested Schema : sdfPropertyList

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

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

Nested Schema : SDFAddressAssociationDetailsDto

Type: object

Show Source

• addressCity: string
• addressCountry: string (uuid)
• addressCountryName: string
• addressPostalCode: string
• addressStateOrProvOrCounty: string (uuid)
• addressStateOrProvOrCountyName: string
• addressStreet1: string
• addressStreet2: string
• addressTypeId(required): string (uuid)
• addressTypeIdCodeValue: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityAddressAssociationId(required): string (uuid)
• entityAddressProperties: array entityAddressProperties
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfAddressProperties: array sdfAddressProperties
• sdfId: string (uuid)
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "addressTypeId",
        "entityAddressAssociationId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeIdCodeValue":{
            "type":"string"
        },
        "entityAddressAssociationId":{
            "type":"string",
            "format":"uuid"
        },
        "addressStreet1":{
            "type":"string"
        },
        "addressStreet2":{
            "type":"string"
        },
        "addressCity":{
            "type":"string"
        },
        "addressPostalCode":{
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "type":"string",
            "format":"uuid"
        },
        "addressStateOrProvOrCountyName":{
            "type":"string"
        },
        "addressCountry":{
            "type":"string",
            "format":"uuid"
        },
        "addressCountryName":{
            "type":"string"
        },
        "entityAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertyDto"
            }
        },
        "sdfAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        }
    }
}

Nested Schema : entityAddressProperties

Type: array

Show Source

• Array of: object PropertyDto
  CTMS Property DTO

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

Nested Schema : sdfAddressProperties

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

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

Nested Schema : PropertyDto

Type: object

CTMS Property DTO

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• entityType: string
  Minimum Length: 0

  Maximum Length: 50

  Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Unique key name of the property.

  Example: LabId
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 500

  Value of the property.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• reason: string
  Minimum Length: 0

  Maximum Length: 255

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "entityType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Unique key name of the property.",
            "example":"LabId"
        },
        "propertyValue":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":" Value of the property.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        }
    },
    "description":"CTMS Property DTO"
}

Nested Schema : SDFPropertyDetailsDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 1024
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "propertyValue":{
            "maxLength":1024,
            "minLength":0,
            "type":"string"
        }
    }
}

Nested Schema : SDFKitSettingDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• kitTypeId(required): string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• settingName(required): string
• settingOperationType: string
• settingValue(required): string
• versionStart: string (date-time)

{
    "required":[
        "kitTypeId",
        "settingName",
        "settingValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "settingName":{
            "type":"string"
        },
        "settingValue":{
            "type":"string"
        },
        "settingOperationType":{
            "type":"string",
            "writeOnly":true
        }
    }
}

400 Response

Bad request.

Body ()

Root Schema : SDFDetailsResponse

Type: object

Show Source

• sdf: object Discriminator: sdfType
  Discriminator: { "propertyName":"sdfType" }
• sdfAddressAssociations: array sdfAddressAssociations
• sdfKitSettingDto: array sdfKitSettingDto
• sdfPropertyList: array sdfPropertyList

{
    "type":"object",
    "properties":{
        "sdf":{
            "$ref":"#/components/schemas/SDFDetailsDto"
        },
        "sdfPropertyList":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        },
        "sdfAddressAssociations":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFAddressAssociationDetailsDto"
            }
        },
        "sdfKitSettingDto":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFKitSettingDto"
            }
        }
    }
}

Nested Schema : Discriminator: sdfType

Type: object

{
    "required":[
        "sdfType"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "tenantEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "studyOrgIdName":{
            "type":"string"
        },
        "statusId":{
            "type":"string",
            "format":"uuid"
        },
        "statusIdCodeValue":{
            "type":"string"
        },
        "oldSdfId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfType":{
            "type":"string"
        }
    },
    "discriminator":{
        "propertyName":"sdfType"
    }
}

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• objectVersionNumber: number
• oldSdfId: string (uuid)
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfType(required): string
• softwareVersionNumber: number
• statusId: string (uuid)
• statusIdCodeValue: string
• studyOrgIdName: string
• tenantEntityId: string (uuid)
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "sdfType"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "tenantEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "studyOrgIdName":{
            "type":"string"
        },
        "statusId":{
            "type":"string",
            "format":"uuid"
        },
        "statusIdCodeValue":{
            "type":"string"
        },
        "oldSdfId":{
            "type":"string",
            "format":"uuid"
        },
        "sdfType":{
            "type":"string"
        }
    },
    "discriminator":{
        "propertyName":"sdfType"
    }
}

Nested Schema : sdfAddressAssociations

Type: array

Show Source

• Array of: object SDFAddressAssociationDetailsDto

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

Nested Schema : sdfKitSettingDto

Type: array

Show Source

• Array of: object SDFKitSettingDto

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

Nested Schema : sdfPropertyList

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

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

Nested Schema : SDFAddressAssociationDetailsDto

Type: object

Show Source

• addressCity: string
• addressCountry: string (uuid)
• addressCountryName: string
• addressPostalCode: string
• addressStateOrProvOrCounty: string (uuid)
• addressStateOrProvOrCountyName: string
• addressStreet1: string
• addressStreet2: string
• addressTypeId(required): string (uuid)
• addressTypeIdCodeValue: string
• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityAddressAssociationId(required): string (uuid)
• entityAddressProperties: array entityAddressProperties
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfAddressProperties: array sdfAddressProperties
• sdfId: string (uuid)
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "addressTypeId",
        "entityAddressAssociationId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "addressTypeIdCodeValue":{
            "type":"string"
        },
        "entityAddressAssociationId":{
            "type":"string",
            "format":"uuid"
        },
        "addressStreet1":{
            "type":"string"
        },
        "addressStreet2":{
            "type":"string"
        },
        "addressCity":{
            "type":"string"
        },
        "addressPostalCode":{
            "type":"string"
        },
        "addressStateOrProvOrCounty":{
            "type":"string",
            "format":"uuid"
        },
        "addressStateOrProvOrCountyName":{
            "type":"string"
        },
        "addressCountry":{
            "type":"string",
            "format":"uuid"
        },
        "addressCountryName":{
            "type":"string"
        },
        "entityAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/PropertyDto"
            }
        },
        "sdfAddressProperties":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SDFPropertyDetailsDto"
            }
        }
    }
}

Nested Schema : entityAddressProperties

Type: array

Show Source

• Array of: object PropertyDto
  CTMS Property DTO

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

Nested Schema : sdfAddressProperties

Type: array

Show Source

• Array of: object SDFPropertyDetailsDto

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

Nested Schema : PropertyDto

Type: object

CTMS Property DTO

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityId: string
  Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• entityType: string
  Minimum Length: 0

  Maximum Length: 50

  Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100

  Unique key name of the property.

  Example: LabId
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 500

  Value of the property.

  Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
• reason: string
  Minimum Length: 0

  Maximum Length: 255

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "description":"Unique identifier (UUID, 32-character uppercase hexadecimal string) of the entity for which the property applies.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        },
        "entityType":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Type of the entity for which the property applies. Type can have value Organization,Contact,Facility,Institution,Investigator,Lab or Depot"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Unique key name of the property.",
            "example":"LabId"
        },
        "propertyValue":{
            "maxLength":500,
            "minLength":0,
            "type":"string",
            "description":" Value of the property.",
            "example":"2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A"
        }
    },
    "description":"CTMS Property DTO"
}

Nested Schema : SDFPropertyDetailsDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• objectVersionNumber: number
• operationType: string
  Minimum Length: 1

  Maximum Length: 16
• propertyName(required): string
  Minimum Length: 0

  Maximum Length: 100
• propertyValue(required): string
  Minimum Length: 0

  Maximum Length: 1024
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• softwareVersionNumber: number
• userId: string (uuid)
• versionEnd: string (date-time)
• versionStart: string (date-time)

{
    "required":[
        "propertyName",
        "propertyValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "versionEnd":{
            "type":"string",
            "format":"date-time"
        },
        "operationType":{
            "maxLength":16,
            "minLength":1,
            "type":"string"
        },
        "userId":{
            "type":"string",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "softwareVersionNumber":{
            "type":"number"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "propertyName":{
            "maxLength":100,
            "minLength":0,
            "type":"string"
        },
        "propertyValue":{
            "maxLength":1024,
            "minLength":0,
            "type":"string"
        }
    }
}

Nested Schema : SDFKitSettingDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• id: string (uuid)
• kitTypeId(required): string (uuid)
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• sdfId: string (uuid)
• settingName(required): string
• settingOperationType: string
• settingValue(required): string
• versionStart: string (date-time)

{
    "required":[
        "kitTypeId",
        "settingName",
        "settingValue"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "id":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "sdfId":{
            "type":"string",
            "format":"uuid"
        },
        "kitTypeId":{
            "type":"string",
            "format":"uuid"
        },
        "settingName":{
            "type":"string"
        },
        "settingValue":{
            "type":"string"
        },
        "settingOperationType":{
            "type":"string",
            "writeOnly":true
        }
    }
}

Back to Top