Versions Compared

Old Version 85

changes.mady.by.user Kimyen Truong

Saved on

compared with

New Version 86

changes.mady.by.user Kimyen Truong

Saved on

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

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

create or update RequestSynapse User/dataAccessRequestPOST
RequestInterfaceRequestInterface
9submit a Requestcreator, ResearchProject's owner/dataAccessRequest/{id}/submissionPOSTetag

SubmissionStatus

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

DataAccessSubmissionStatus
11cancel a Submissionrequestor, ResearchProject's owner/dataAccessSubmission/{id}/cancellationPUT

SubmissionStatus

12update a SubmissionACT/dataAccessSubmission/{id}PUT
SubmissionStateChangeRequestSubmissionStatus
13retrieve a list of SubmissionACT/accessRequirement/{id}/submissionsGETnextPageToken, order (SubmissionOrder), filter (SubmissionState),
asc 
SubmissionPage
14retrieve a list of Approval Status for a given list of AccessRequirementSynapseUser/accessApprovalStatusPOST
AccessApprovalStatusRequestAccessApprovalStatusResults
15retrieve restriction info for a given entitySynapse user/entity/{id}/restrictionInformationGETRestrictionInforestrictionInformationPOST
RestrictionInformationRequestRestrictionInformationResponse
16retrieve access requirement statusSynapse user/accessRequirement/{id}/statusGET

AccessRequirementStatus
17retrieve info about open submissionsACT/dataAccessSubmission/openSubmissionsGETnextPageToken
OpenSubmissionPage
18retrieve approval info for usersACT/accessApproval/batchPOST
BatchAccessApprovalRequestBatchAccessApprovalResult

...

RestrictionInfo
SubmissionStateChangeRequest
String submissionId
SubmissionState newState (only APPROVED and REJECTED are valid)
String rejectedReason


RestrictionInformationRequest
String objectId

RestrictableObjectType objectType


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

...