Class Reference

rwslib

exception rwslib.AuthorizationException

Raised if a request requires authorization but no authorization header is provided

class rwslib.RWSConnection(domain, username=None, password=None, auth=None, virtual_dir='RaveWebServices')

A connection to RWS

Create a connection to Rave

Parameters:
  • domain (str) – Rave URL Name
  • username (str) – Rave User Login
  • password (str) – Rave User password
  • auth (str) – Authentication tuple (usually something like (username, password)
  • virtual_dir (str) – Name of the Rave Web Services prefix (usually RaveWebServices, but can be customised)

Note

If the domain does not start with http then it is assumed to be the name of the Medidata url and https:// will be added as a prefix and .mdsol.com will be added as a postfix.

send_request(request_object, timeout=None, retries=1, **kwargs)

Send request to RWS endpoint. The request object passed provides the URL endpoint and the HTTP method. Takes the text response from RWS and allows the request object to modify it for return. This allows the request object to return text, an XML document object, a CSV file or anything else that can be generated from the text response from RWS. A timeout, in seconds, can be optionally passed into send_request.

Rave Web Services Request Objects

Core request classes that implement calls available in all versions of RWS.

RWSRequest subclasses represent URL endpoints. They can be passed to a RWSConnection get or post method as appropriate.

TODO: Note that might want to make the Request objects responsible for deciding whether they are get, post, patch etc.

class rwslib.rws_requests.BuildVersionRequest

Return the RWS build version number

class rwslib.rws_requests.CacheFlushRequest

Calls RWS cache-flush

result(response)

Return RWSResponse object for success :param requests.models.Response response: request respnse

class rwslib.rws_requests.ClinicalStudiesRequest

Return the list of clinical studies as a RWSStudies object. Clinical studies are the studies that you have access to as an EDC user.

result(response)

Return RWSResponse object for success :param requests.models.Response response: request respnse

class rwslib.rws_requests.CodeNameRequest

Return the RWS version codename

class rwslib.rws_requests.ConfigurableDatasetRequest(dataset_name, dataset_format='', params={})

Create a new Configurable Dataset Request :param dataset_name: Name for the dataset :type dataset_name: str :param dataset_format: Format for the dataset :type dataset_format: str :param params: set of parameters to pass to URL :type params: dict

dataset

Qualify the dataset_name with the dataset_format if supplied :return: dataset name :rtype: str

class rwslib.rws_requests.DiagnosticsRequest

Return the RWS build version number

class rwslib.rws_requests.GlobalLibrariesRequest

Return the list of global libraries as a RWSStudies object. metadata_libraries are the list of libraries that you have access to as an Architect Global Library Volume user

result(response)

Return RWSResponse object for success :param requests.models.Response response: request respnse

class rwslib.rws_requests.GlobalLibraryDraftsRequest(project_name)

Return the list of global library drafts

Parameters:project_name (str) – Project Name
result(response)

Return RWSResponse object for success :param requests.models.Response response: request respnse

class rwslib.rws_requests.GlobalLibraryVersionRequest(project_name, oid)

Return a global library version as a string

Parameters:
  • project_name (str) – Project Name
  • oid (int) – Metadata version OID (CRF Draft Number)
class rwslib.rws_requests.GlobalLibraryVersionsRequest(project_name)

Return the list of global library versions

Parameters:project_name (str) – Project Name
result(response)

Return RWSResponse object for success :param requests.models.Response response: request respnse

class rwslib.rws_requests.MetadataStudiesRequest

Return the list of metadata studies as a RWSStudies object. metadata_studies are the list of studies that you have access to as an Architect user.

result(response)

Return RWSResponse object for success :param requests.models.Response response: request respnse

class rwslib.rws_requests.ODMDatasetBase
class rwslib.rws_requests.PostDataRequest(data, headers={'Content-type': 'text/xml'})

Post an ODM data transaction to Rave, get back an RWSResponse object

Post an ODM to a RWS endpoint :param bytes data: Data to POST :param dict headers: Headers to add to request

args()

Return additional args here as dict (only for post data requests)

result(response)

Return RWSPostResponse object for success :param requests.models.Response response: request response

class rwslib.rws_requests.PostMetadataRequest(project_name, data, headers={'Content-type': 'text/xml'})

Post an ODM data transaction to Rave, get back an RWSResponse object

Parameters:
  • project_name (str) – Project Name
  • data (str) – Data to dispatch
  • headers (dict) – Headers to pass to client
args()

Return additional args here as dict (only for post data requests)

result(response)

Return RWSPostResponse object for success :param requests.models.Response response: request respnse

class rwslib.rws_requests.QueryOptionGetRequest

Manages requests that have known query string options

class rwslib.rws_requests.RWSAuthorizedGetRequest
class rwslib.rws_requests.RWSAuthorizedPostRequest
class rwslib.rws_requests.RWSGetRequest
class rwslib.rws_requests.RWSPostRequest
class rwslib.rws_requests.RWSRequest

Base class for all RWS Requests

args()

Return additional args here as dict

result(response)

Process a result to create a custom output :param requests.models.Response response: returned response :return:

class rwslib.rws_requests.StudyDatasetRequest(project_name, environment_name, dataset_type='regular', start=None, rawsuffix=None, formoid=None, versionitem=None, codelistsuffix=None, decodesuffix=None, stdsuffix=None)

Return the text of the full datasets listing as an ODM string.

Parameters:
  • project_name (str) – Name of the Rave Study
  • environment_name (str) – Name of the Rave Study Environment
  • dataset_type (str) – Dataset type, one of ‘regular’ or ‘raw’
  • start (str) – Start date for the Report (iso8601)
  • rawsuffix (str) – Adds raw data values to a full or incremental dataset, and identifies these values with {rawsuffix}.
  • formoid (str) – FormOID for which to report
  • versionitem (str) – Adds the subject’s CRF version to the dataset, and identifies it with {version-item}
  • codelistsuffix (str) – Adds code list OIDS for fields that use a code list to the dataset, and identifies these values with {codelistsuffix}.
  • decodesuffix (str) – Add decoded values of items that have an associated code list to the dataset, and identifies these values with {decodesuffix}.
  • stdsuffix (str) – Adds standard data values to a full or incremental dataset, and identifies these values with {stdsuffix}.
class rwslib.rws_requests.StudyDraftsRequest(project_name)

Return the list of study drafts

Parameters:project_name (str) – Project Name
result(response)

Return RWSResponse object for success :param requests.models.Response response: request respnse

class rwslib.rws_requests.StudySubjectsRequest(project_name, environment_name, status=False, include=None, subject_key_type='SubjectName', links=False)

Return the list of study subjects, defaults to the PROD environment

Parameters:
  • project_name (str) – Project/Study Name
  • environment_name (str) – Study Environment Name (eg Prod)
  • status (bool) – Add subject level workflow status
  • include (str) – Query option to add to include parameter (see INCLUDE_OPTIONS for allowed values)
  • subject_key_type (str) – Type of SubjectKey to have in the response (one of SubjectName or SubjectUUID)
  • links (bool) – Add Deep Links to Output ODM

Note

If status == True then ?status=all If include then include parameter is also added to query string

result(response)

Return RWSSubjects object for success :param requests.models.Response response: request response

class rwslib.rws_requests.StudyVersionRequest(project_name, oid)

Return a study version as a string

Parameters:
  • project_name (str) – Project Name
  • oid (int) – Metadata version OID (CRF Draft Number)
class rwslib.rws_requests.StudyVersionsRequest(project_name)

Return the list of study versions

Parameters:project_name (str) – Project Name
result(response)

Return RWSResponse object for success :param requests.models.Response response: request respnse

class rwslib.rws_requests.SubjectDatasetRequest(project_name, environment_name, subjectkey, dataset_type='regular', start=None, rawsuffix=None, formoid=None, versionitem=None, codelistsuffix=None, decodesuffix=None, stdsuffix=None)

Return the text of the full datasets for a version as an ODM string. By supplying formoid, will be filtered to just that formoid data

Parameters:
  • project_name (str) – Name of the Rave Study
  • environment_name (str) – Name of the Rave Study Environment
  • dataset_type (str) – Dataset type, one of ‘regular’ or ‘raw’
  • start (str) – Start date for the Report (iso8601)
  • rawsuffix (str) – Adds raw data values to a full or incremental dataset, and identifies these values with {rawsuffix}.
  • formoid (str) – FormOID for which to report
  • versionitem (str) – Adds the subject’s CRF version to the dataset, and identifies it with {version-item}
  • codelistsuffix (str) – Adds code list OIDS for fields that use a code list to the dataset, and identifies these values with {codelistsuffix}.
  • decodesuffix (str) – Add decoded values of items that have an associated code list to the dataset, and identifies these values with {decodesuffix}.
  • stdsuffix (str) – Adds standard data values to a full or incremental dataset, and identifies these values with {stdsuffix}.
  • subjectkey (str) – Subject Key for subject for which to report
class rwslib.rws_requests.TwoHundredRequest

Return RWS MAuth information

class rwslib.rws_requests.VersionDatasetRequest(project_name, environment_name, version_oid, dataset_type='regular', start=None, rawsuffix=None, formoid=None, versionitem=None, codelistsuffix=None, decodesuffix=None, stdsuffix=None)

Return the text of the full datasets for a version as an ODM string. By supplying formoid, will be filtered to just that formoid data

Parameters:
  • project_name (str) – Name of the Rave Study
  • environment_name (str) – Name of the Rave Study Environment
  • dataset_type (str) – Dataset type, one of ‘regular’ or ‘raw’
  • start (str) – Start date for the Report (iso8601)
  • rawsuffix (str) – Adds raw data values to a full or incremental dataset, and identifies these values with {rawsuffix}.
  • formoid (str) – FormOID for which to report
  • versionitem (str) – Adds the subject’s CRF version to the dataset, and identifies it with {version-item}
  • codelistsuffix (str) – Adds code list OIDS for fields that use a code list to the dataset, and identifies these values with {codelistsuffix}.
  • decodesuffix (str) – Add decoded values of items that have an associated code list to the dataset, and identifies these values with {decodesuffix}.
  • stdsuffix (str) – Adds standard data values to a full or incremental dataset, and identifies these values with {stdsuffix}.
  • version_oid (str) – version for which to report
class rwslib.rws_requests.VersionRequest

Get RWS Version number

class rwslib.rws_requests.VersionRequestBase(project_name, oid)

Base class for study and library metadata version requests

Parameters:
  • project_name (str) – Project Name
  • oid (int) – Metadata version OID (CRF Draft Number)
result(response)

Return RWSResponse object for success :param requests.models.Response response: request respnse

rwslib.rws_requests.check_dataset_type(dataset_type)

Datasets may only be regular or raw :type dataset_type: str

rwslib.rws_requests.format_date_argument(date_element)

Take a date as either a datetime.date/datetime or a string and return it as a iso8601 formatted value :param Union[datetime.date, datetime.datetime] date_element: passed argument :rtype str :return:

rwslib.rws_requests.make_url(*args, **kwargs)

Makes a URL from component parts

Rave Web Services Objects

class rwslib.rwsobjects.MetaDataVersion

A single MetaDataVersion instance

<MetaDataVersion OID="1203" Name="Webservice Outbound"/>
classmethod fromElement(elem)

Read properties from a MetaDataVersion element

Parameters:elem (lxml.etree._Element) – Source etree Element
class rwslib.rwsobjects.ODMDoc(xml)

A base ODM document

Abstract Doc Class :param bytes xml: Input content

class rwslib.rwsobjects.RWSError(xml)

Extends ODMDoc, inheriting attributes like filetype, creationdatetime etc.

Parses XML of the form:

<?xml version="1.0" encoding="utf-8"?>
<ODM xmlns:mdsol="http://www.mdsol.com/ns/odm/metadata"
     FileType="Snapshot"
     CreationDateTime="2013-04-08T10:28:49.578-00:00"
     FileOID="4d13722a-ceb6-4419-a917-b6ad5d0bc30e"
     ODMVersion="1.3"
     mdsol:ErrorDescription="Incorrect login and password combination. [RWS00008]"
     xmlns="http://www.cdisc.org/ns/odm/v1.3" />
class rwslib.rwsobjects.RWSErrorResponse(xml)

Parses messages of the form:

<Response
    ReferenceNumber="0b47fe86-542f-4070-9e7d-16396a5ef08a"
    InboundODMFileOID="Not Supplied"
    IsTransactionSuccessful="0"
    ReasonCode="RWS00092"
    ErrorClientResponseMessage="CRF version not found">
</Response>
exception rwslib.rwsobjects.RWSException(msg, rws_error)

RWS Exception. Usual to attach the error response object

Parameters:
  • msg (str) – Error message (base)
  • rws_error (str) – RWS error message
class rwslib.rwsobjects.RWSPostErrorResponse(xml)

Responses to Clinical data post messages have additional Attributes to normal RWS Response messages:

<Response
    ReferenceNumber="5b1fa9a3-0cf3-46b6-8304-37c2e3b7d04f"
    InboundODMFileOID="1"
    IsTransactionSuccessful = "0"
    ReasonCode="RWS00024"
    ErrorOriginLocation="/ODM/ClinicalData[1]/SubjectData[1]"
    SuccessStatistics="Rave objects touched: Subjects=0; Folders=0; Forms=0; Fields=0; LogLines=0"
    ErrorClientResponseMessage="Subject already exists.">
</Response>
Parameters:xml (str) – Error response
class rwslib.rwsobjects.RWSPostResponse(xml)

Parses responses from PostODMClinicalData messages with the format:

<Response ReferenceNumber="82e942b0-48e8-4cf4-b299-51e2b6a89a1b"
          InboundODMFileOID=""
          IsTransactionSuccessful="1"
          SuccessStatistics="Rave objects touched: Subjects=0; Folders=0; Forms=0; Fields=0; LogLines=0" NewRecords=""
          SubjectNumberInStudy="1103" SubjectNumberInStudySite="55">
</Response>
class rwslib.rwsobjects.RWSResponse(xml)

Parses messages of the form:

<Response ReferenceNumber="82e942b0-48e8-4cf4-b299-51e2b6a89a1b"
    InboundODMFileOID=""
    IsTransactionSuccessful="1"
    SuccessStatistics="Rave objects touched: Subjects=0; Folders=0; Forms=0; Fields=0; LogLines=0" NewRecords="">
</Response>
class rwslib.rwsobjects.RWSStudies(xml)

Represents a list of studies. Extends the list class and adds a couple of extra properties:

<ODM FileType="Snapshot" FileOID="767a1f8b-7b72-4d12-adbe-37d4d62ba75e"
     CreationDateTime="2013-04-08T10:02:17.781-00:00"
     ODMVersion="1.3"
     xmlns:mdsol="http://www.mdsol.com/ns/odm/metadata"
     xmlns:xlink="http://www.w3.org/1999/xlink"
     xmlns="http://www.cdisc.org/ns/odm/v1.3">
     <Study OID="Fixitol(Dev)">
        <GlobalVariables>
              <StudyName>Fixitol (Dev)</StudyName>
              <StudyDescription/>
              <ProtocolName>Fixitol</ProtocolName>
        </GlobalVariables>
     </Study>
     <Study OID="IANTEST(Prod)">
        <GlobalVariables>
              <StudyName>IANTEST</StudyName>
              <StudyDescription/>
              <ProtocolName>IANTEST</ProtocolName>
        </GlobalVariables>
     </Study>
</ODM>
class rwslib.rwsobjects.RWSStudyListItem(oid=None, studyname=None, protocolname=None, environment=None, projecttype=None)

An item in the RWS Study List response

Parameters:
  • oid (str) – Study OID
  • studyname (str) – Study Name
  • protocolname (str) – Protocol Name
  • environment (str) – Study Environment
  • projecttype (str) – Project Type
classmethod fromElement(elem)

Read properties from an XML Element to build a StudyList Item

Parameters:elem (lxml.etree.Element) – The source Study XML Element
<Study OID="Fixitol(Dev)" mdsol:ProjectType="GlobalLibraryVolume">
    <GlobalVariables>
        <StudyName>Fixitol (Dev)</StudyName>
        <StudyDescription/>
        <ProtocolName>Fixitol</ProtocolName>
    </GlobalVariables>
</Study>
isProd()

Is production if environment is empty

Return type:bool
class rwslib.rwsobjects.RWSStudyMetadataVersions(xml)

Parses responses from MetaDataVersions request:

<ODM ODMVersion="1.3" Granularity="Metadata" FileType="Snapshot" FileOID="d26b4d33-376d-4037-9747-684411190179" CreationDateTime=" 2013-04-08T01:29:13 " xmlns="http://www.cdisc.org/ns/odm/v1.3" xmlns:mdsol="http://www.mdsol.com/ns/odm/metadata">
    <Study OID="IANTEST">
        <GlobalVariables>
            <StudyName>IANTEST</StudyName>
            <StudyDescription></StudyDescription>
            <ProtocolName>IANTEST</ProtocolName>
        </GlobalVariables>
        <MetaDataVersion OID="1203" Name="Webservice Outbound" />
        <MetaDataVersion OID="1195" Name="JC_Demo_Draft1" />
        <MetaDataVersion OID="1165" Name="Initial" />
    </Study>
</ODM>
class rwslib.rwsobjects.RWSSubjectListItem

Parses response of Subject List request:

<ClinicalData StudyOID="Fixitol(Dev)" MetaDataVersionOID="1111">
 <SubjectData SubjectKey="1111">
    <SiteRef LocationOID="335566"/>
 </SubjectData>
</ClinicalData>

Optionally ClinicalData may include status:

<SubjectData SubjectKey="1111" mdsol:Overdue="No"
          mdsol:Touched="Yes"
          mdsol:Empty="No"
          mdsol:Incomplete="No"
          mdsol:NonConformant="No"
          mdsol:RequiresSecondPass="No"
          mdsol:RequiresReconciliation="No"
          mdsol:RequiresVerification="No"
          mdsol:Verified="No"
          mdsol:Frozen="No"
          mdsol:Locked="No"
          mdsol:RequiresReview="No"
          mdsol:PendingReview="No"
          mdsol:Reviewed="No"
          mdsol:RequiresAnswerQuery="No"
          mdsol:RequiresPendingCloseQuery="No"
          mdsol:RequiresCloseQuery="No"
          mdsol:StickyPlaced="No"
          mdsol:Signed="No"
          mdsol:SignatureCurrent="No"
          mdsol:RequiresTranslation="No"
          mdsol:RequiresCoding="No"
          mdsol:RequiresPendingAnswerQuery="No"
          mdsol:RequiresSignature="No"
          mdsol:ReadyForFreeze="No"
          mdsol:ReadyForLock="Yes">

The SubjectKey can be either a Subject ID or a UUID depending on the value of SubjectKeyType:

<ClinicalData StudyOID="Fixitol(Dev)" MetaDataVersionOID="1111">
 <SubjectData SubjectKey="EC82F1AB-D463-4930-841D-36FC865E63B2" mdsol:SubjectName="1" mdsol:SubjectKeyType="SubjectUUID">
    <SiteRef LocationOID="335566"/>
 </SubjectData>
</ClinicalData>

The Response may include links:

<ClinicalData StudyOID="Fixitol(Dev)" MetaDataVersionOID="1111">
 <SubjectData SubjectKey="1111">
    <SiteRef LocationOID="335566"/>
    <mdsol:Link xlink:type="simple" xlink:href="http://innovate.mdsol.com/MedidataRAVE/HandleLink.aspx?page=SubjectPage.aspx?ID=849" />
 </SubjectData>
</ClinicalData>

The ODM message has a ClinicalData element with a single SubjectData and SiteRef elements nested within. I collapse into a single object

classmethod fromElement(elem)

Read properties from an XML Element

subject_name

Get the subject name consistently :rtype str :return: The Subject ID for the subject

Note

  • If the SubjectKeyType is SubjectUUID then the subject name lives in the mdsol:SubjectName attribute
  • If the SubjectKeyType is SubjectName then the subject name lives in the SubjectKey attribute
class rwslib.rwsobjects.RWSSubjects(xml)

Represents a list of subjects:

<ODM FileType="Snapshot"
     FileOID="770f1758-db33-4ab2-af72-38db863734aa"
     CreationDateTime="2013-04-08T14:08:06.875-00:00"
     ODMVersion="1.3">

     <ClinicalData StudyOID="Fixitol(Dev)" MetaDataVersionOID="1111">
        <SubjectData SubjectKey="000001">
           <SiteRef LocationOID="BP001"/>
           <mdsol:Link xlink:type="simple" xlink:href="http://innovate.mdsol.com/MedidataRAVE/HandleLink.aspx?page=SubjectPage.aspx?ID=849" />
        </SubjectData>
     </ClinicalData>

     <ClinicalData StudyOID="Fixitol(Dev)" MetaDataVersionOID="1111">
         <SubjectData SubjectKey="1111">
            <SiteRef LocationOID="335566"/>
            <mdsol:Link xlink:type="simple" xlink:href="http://innovate.mdsol.com/MedidataRAVE/HandleLink.aspx?page=SubjectPage.aspx?ID=849" />
         </SubjectData>
     </ClinicalData>
</ODM>
class rwslib.rwsobjects.XMLRepr(xml)

Classes that represent objects passed back from RWS as XML

Parameters:xml (str) – XML returned from RWS
rwslib.rwsobjects.getEnvironmentFromNameAndProtocol(studyname, protocolname)

Extract environment name using studyname and protocolname to guide :param str studyname: Name of the study (including Env) :param str protocolname: Name of the study

rwslib.rwsobjects.parseXMLString(xml)

Parse XML string, return root :param str: Passed in XML

Biostats Gateway

Views related to clinical views and their metadata, Biostats Gateway/Adapter

http://rws-webhelp.s3.amazonaws.com/WebHelp_ENG/solutions/01_biostat_adapter.html#biostat-adapter

class rwslib.rws_requests.biostats_gateway.CVMetaDataRequest(project_name, environment_name, versionitem=None, rawsuffix=None, codelistsuffix=None, decodesuffix=None)

Return Clinical View Metadata as ODM string

Parameters:
  • project_name (str) – Project Name
  • environment_name (str) – Environment Name
  • versionitem (str) – Adds the subject’s CRF version to the dataset, and identifies it with versionitem
  • rawsuffix (str) – Adds raw data values to a full or incremental dataset, and identifies these values with rawsuffix.
  • codelistsuffix (str) – Adds code list OIDS for fields that use a code list to the dataset, and identifies these values with codelistsuffix
  • decodesuffix (str) – Add decoded values of items that have an associated code list to the dataset, and identifies these values with decodesuffix.
studyname_environment()

Combine the Study Name and Environment

Return type:str
class rwslib.rws_requests.biostats_gateway.CommentDataRequest(project_name, environment_name, dataset_format='csv')

Return Comments from Rave as CSV or XML

Parameters:
  • project_name (str) – Project Name
  • dataset_format (str) – Specify format of the Datasets (either csv or xml)
  • environment_name (str) – Environment Name
class rwslib.rws_requests.biostats_gateway.DataDictionariesRequest(project_name, environment_name, dataset_format='csv')

Retrieve Data Dictionaries from Rave

Parameters:
  • project_name (str) – Project Name
  • dataset_format (str) – Specify format of the Datasets (either csv or xml)
  • environment_name (str) – Environment Name
class rwslib.rws_requests.biostats_gateway.FormDataRequest(project_name, environment_name, dataset_type, form_oid, start=None, dataset_format='csv')

Return CV Form Data as CSV or XML

Parameters:
  • project_name (str) – Project Name
  • environment_name (str) – Environment Name
  • dataset_type (str) – Type of dataset (either regular or raw)
  • form_oid (str) – OID for the Form of interest
  • start (str) – Start Date for the dataset pull (should be an iso8601 formatted date)
  • dataset_format (str) – Specify format of the Datasets (either csv or xml)
class rwslib.rws_requests.biostats_gateway.MetaDataRequest(dataset_format='csv')

Return Metadata for Clinical Views in CSV or XML fornat

Parameters:dataset_format (str) – Specify format of the Datasets (either csv or xml)
class rwslib.rws_requests.biostats_gateway.ProjectMetaDataRequest(project_name, dataset_format='csv')

Return Metadata for Clinical Views in CSV or XML format for a Project

Parameters:
  • project_name (str) – Project Name
  • dataset_format (str) – Specify format of the Datasets (either csv or xml)
class rwslib.rws_requests.biostats_gateway.ProtocolDeviationsRequest(project_name, environment_name, dataset_format='csv')

Retrieve Protocol Deviation Information from Rave

Parameters:
  • project_name (str) – Project Name
  • dataset_format (str) – Specify format of the Datasets (either csv or xml)
  • environment_name (str) – Environment Name
class rwslib.rws_requests.biostats_gateway.ViewMetaDataRequest(view_name, dataset_format='csv')

Return Metadata for Clinical Views in CSV fornat for a single View

Parameters:
  • view_name (str) – Clinical View of interest
  • dataset_format (str) – Specify format of the Datasets (either csv or xml)
rwslib.rws_requests.biostats_gateway.check_dataset_format(ds_format)

Ensure dataset format is XML or CSV

Parameters:ds_format (str) – Format of the Dataset (expected to be one of csv or xml)
rwslib.rws_requests.biostats_gateway.dataset_format_to_extension(ds_format)

Get the preferred Dataset format extension

Parameters:ds_format (str) – Format of the Dataset (expected to be one of csv or xml)
Return type:str

ODM Adapter

Requests related to the ODM Adapter

http://rws-webhelp.s3.amazonaws.com/WebHelp_ENG/solutions/clinical_data_audits/index.html#odm-adapter

class rwslib.rws_requests.odm_adapter.AuditRecordsRequest(project_name, environment_name, startid=1, per_page=100)

Clinical Audit Records Dataset

Parameters:
  • project_name (str) – Project Name
  • environment_name (str) – Environment Name
  • startid (int) – Starting Audit
  • per_page (int) – Page Size
class rwslib.rws_requests.odm_adapter.SignatureDefinitionsRequest(project_name)

Return signature definitions for all versions of the study

Parameters:project_name (str) – Project Name
class rwslib.rws_requests.odm_adapter.SitesMetadataRequest(project_name=None, environment_name=None)

List all sites in a study along with their StudyVersions

Parameters:
  • project_name (str) – Project Name
  • environment_name (str) – Environment Name
class rwslib.rws_requests.odm_adapter.UsersRequest(project_name, environment_name, location_oid=None)

Return list of users for study (can be filtered by location)

Parameters:
  • project_name (str) – Project Name
  • environment_name (str) – Environment Name
  • location_oid (str) – Study Site Name to filter with
class rwslib.rws_requests.odm_adapter.VersionFoldersRequest(project_name, environment_name)

Identify all folders in use in study

Parameters:
  • project_name (str) – Project Name
  • environment_name (str) – Environment Name