Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...


ActionIntended UserURIMethodRequest ParamsRequest BodyResponse Body
1create a ResearchProjectSynapse User/researchProjectPOST
ResearchProjectResearchProject
2retrieve a ResearchProjectcreator/accessRequirement/{id}/researchProjectGET

ResearchProject
3update a ResearchProjectcreator/researchProject/{id}PUT
ResearchProjectResearchProject
4transfer ownership of a ResearchProjectcreator, ACT/researchProject/{id}/updateOwnerPUT
ChangeOwnershipRequestResearchProject

create or update Research ProjectSynapse User/researchProjectPOST
ResearchProjectResearchProject

get ResearchProject for updatecreator/accessRequirement/{id}/researchProjectForUpdateGET

ResearchProject
5create a DataAccessRequestSynapse User/dataAccessRequestPOST
DataAccessRequestDataAccessRequest
6retrieve the current DataAccessRequestcreator, ResearchProject's owner/accessRequirement/{id}/dataAccessRequestGET

DataAccessRequestInterface
7asking the server for a suitable request object to start withcreator/accessRequirement/{id}/dataAccessRequestForUpdateGET

DataAccessRequestInterface
8update a DataAccessRequestcreator, ResearchProject's owner/dataAccessRequest/{id}PUT
DataAccessRequestInterfaceDataAccessRequestInterface

create or update DataAccessRequestSynapse User/dataAccessRequestPOST
DataAccessRequestInterfaceDataAccessRequestInterface
9submit a DataAccessRequestcreator, ResearchProject's owner/dataAccessRequest/{id}/submissionPOSTetag
DataAccessSubmissionStatus

ACTAccessRequirementStatus

10retrieve the latest DataAccessSubmission's statusrequestor, ResearchProject's owner, accessors/accessRequirement/{id}/submissionStatusGET

DataAccessSubmissionStatusDataAccessSubmissionStatus
11cancel a DataAccessSubmissionrequestor, ResearchProject's owner/dataAccessSubmission/{id}/cancellationPUT

DataAccessSubmissionStatus

ACTAccessRequirementStatus

12update a DataAccessSubmissionACT/dataAccessSubmission/{id}PUT
SubmissionStateChangeRequestDataAccessSubmission
13retrieve a list of DataAccessSubmissionACT/accessRequirement/{id}/submissionsGETnextPageToken, order (DataAccessSubmissionOrder), filter (DataAccessSubmissionState),
ascĀ 

DataAccessSubmissionPage
14retrieve a list of Approval Status for a given list of AccessRequirementSynapseUser/accessApprovalStatusPOST
AccessApprovalStatusRequestAccessApprovalStatusResults
ChangeOwnershipRequest
String researchProjectId
String newOwnerId
DataAccessSubmissionStatus
15retrieve restriction info for a given entitySynapse user/entity/{id}/restrictionInfoGET

RestrictionInfo
16retrieve access requirement statusSynapse user/accessRequirement/{id}/statusGET

AccessRequirementStatus


ACTAccessRequirementStatus implements AccessRequirementStatus
String accessRequirementId
String submissionId
DataAccessSubmissionState state
String rejectedReason
Long reviewedOn

...

Status (APPROVED, NOT_APPROVED)
SubmissionStateChangeRequest
String submissionId
DataAccessSubmissionState newState (only APPROVED and REJECTED are valid)
String rejectedReason
AccessApprovalStatusRequest
List<String> accessRequirementIdList
AccessApprovalStatusResults
List<AccessApprovalStatusResult> results
ACTAccessApprovalStatusResult implements AccessApprovalStatusResult
String accessRequirementId
Status (NOT_SUBMITTED, SUBMITTED, APPROVED, REJECTED)
TermsOfUseAccessApprovalStatus implements AccessApprovalStatusResult
String accessRequirementId


RestrictionInfo
RestrictionLevel restrictionLevel (OPEN, RESTRICTED_BY_TERMS_OF_USE, CONTROLLED_BY_ACT)
boolean hasUnmet


TermsOfUseAccessRequirementStatus implements AccessRequirementStatus
String accessRequirementId
boolean isApproved



Compare behaviors of #6 and #7

...