public interface SharedAssessmentsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Message> |
deleteSharedAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
deleteSharedAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting a shared assessment
|
retrofit2.Call<Assessment> |
getLatestSharedAssessmentRevision(String identifier)
Get an assessment revision with the greatest revision number, using the assessment's identifier.
|
retrofit2.Call<Assessment> |
getSharedAssessmentByGUID(String guid)
Get an assessment revision.
|
retrofit2.Call<Assessment> |
getSharedAssessmentById(String identifier,
Long revision)
Get an assessment revision by identifier and revision number.
|
retrofit2.Call<AssessmentConfig> |
getSharedAssessmentConfig(String guid)
Get the configuration JSON for a shared assessment app context.
|
retrofit2.Call<ExternalResource> |
getSharedAssessmentResource(String assessmentId,
String guid)
Get a external resource link documenting a shared assessment
|
retrofit2.Call<PagedExternalResourceList> |
getSharedAssessmentResources(String assessmentId,
Integer offsetBy,
Integer pageSize,
List<String> category,
Integer minRevision,
Integer maxRevision,
Boolean includeDeleted)
Get the external resource links documenting an assessment
|
retrofit2.Call<AssessmentList> |
getSharedAssessmentRevisionsByGUID(String guid,
Integer offsetBy,
Integer pageSize,
Boolean includeDeleted)
Get all revisions of an assessment using the GUID of one of the revisions.
|
retrofit2.Call<AssessmentList> |
getSharedAssessmentRevisionsById(String identifier,
Integer offsetBy,
Integer pageSize,
Boolean includeDeleted)
Get all revisions of an assessment with a specific identifier.
|
retrofit2.Call<AssessmentList> |
getSharedAssessments(Integer offsetBy,
Integer pageSize,
List<String> tag,
Boolean includeDeleted)
Get assessments in the shared library.
|
retrofit2.Call<Assessment> |
importSharedAssessment(String guid,
String ownerId,
String newIdentifier)
Import an assessment revision into the local app context.
|
retrofit2.Call<ExternalResourceList> |
importSharedAssessmentResource(String assessmentId,
List<String> externalResourceGUIDs)
Copy these shared resources to your app context
The shared assessment these resources relate to must have been imported at least one time to the local app context before the resources can be imported.
|
retrofit2.Call<Assessment> |
updateSharedAssessment(String guid,
Assessment assessment)
Update an assessment revision.
|
retrofit2.Call<ExternalResource> |
updateSharedAssessmentResource(String assessmentId,
String guid,
ExternalResource externalResource)
Update an external resource link documenting a shared assessment
|
@Headers(value="Content-Type:application/json") @DELETE(value="v1/sharedassessments/{guid}") retrofit2.Call<Message> deleteSharedAssessment(@Path(value="guid") String guid, @Query(value="physical") Boolean physical)
guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @DELETE(value="v1/sharedassessments/identifier:{assessmentId}/resources/{guid}") retrofit2.Call<Message> deleteSharedAssessmentResource(@Path(value="assessmentId") String assessmentId, @Path(value="guid") String guid, @Query(value="physical") Boolean physical)
assessmentId
- The identifier for a stream of assessment revisions (required)guid
- A guid (required)physical
- Physically delete this resource? (administrators only; this is always false for developers) (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="v1/sharedassessments/identifier:{identifier}") retrofit2.Call<Assessment> getLatestSharedAssessmentRevision(@Path(value="identifier") String identifier)
identifier
- identifier (required)@Headers(value="Content-Type:application/json") @GET(value="v1/sharedassessments/{guid}") retrofit2.Call<Assessment> getSharedAssessmentByGUID(@Path(value="guid") String guid)
guid
- A guid (required)@Headers(value="Content-Type:application/json") @GET(value="v1/sharedassessments/identifier:{identifier}/revisions/{revision}") retrofit2.Call<Assessment> getSharedAssessmentById(@Path(value="identifier") String identifier, @Path(value="revision") Long revision)
identifier
- identifier (required)revision
- Revision number (required)@Headers(value="Content-Type:application/json") @GET(value="v1/sharedassessments/{guid}/config") retrofit2.Call<AssessmentConfig> getSharedAssessmentConfig(@Path(value="guid") String guid)
guid
- A guid (required)@Headers(value="Content-Type:application/json") @GET(value="v1/sharedassessments/identifier:{assessmentId}/resources/{guid}") retrofit2.Call<ExternalResource> getSharedAssessmentResource(@Path(value="assessmentId") String assessmentId, @Path(value="guid") String guid)
assessmentId
- The identifier for a stream of assessment revisions (required)guid
- A guid (required)@Headers(value="Content-Type:application/json") @GET(value="v1/sharedassessments/identifier:{assessmentId}/resources") retrofit2.Call<PagedExternalResourceList> getSharedAssessmentResources(@Path(value="assessmentId") String assessmentId, @Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize, @Query(value="category") List<String> category, @Query(value="minRevision") Integer minRevision, @Query(value="maxRevision") Integer maxRevision, @Query(value="includeDeleted") Boolean includeDeleted)
assessmentId
- The identifier for a stream of assessment revisions (required)offsetBy
- next page start offset for pagination (optional, default to 0)pageSize
- maximum number of records in each returned page (optional, default to 50)category
- One or more category values. Searches specifying more than one category will return a resource if it matches *any* of the categories given (it does not need to match all of them). (optional)minRevision
- If this parameter is set, only resoures with a `createdAtRevision` value >= minRevision will be returned from the API (if the parameter is left null, all resources will be considered to match). (optional)maxRevision
- If this parameter is set, only resources with a `createdAtRevision` value <= maxRevision will be returned from the API (if the parameter is left null, all resources will be considered to match). (optional)includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="v1/sharedassessments/{guid}/revisions") retrofit2.Call<AssessmentList> getSharedAssessmentRevisionsByGUID(@Path(value="guid") String guid, @Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize, @Query(value="includeDeleted") Boolean includeDeleted)
guid
- A guid (required)offsetBy
- next page start offset for pagination (optional, default to 0)pageSize
- maximum number of records in each returned page (optional, default to 50)includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="v1/sharedassessments/identifier:{identifier}/revisions") retrofit2.Call<AssessmentList> getSharedAssessmentRevisionsById(@Path(value="identifier") String identifier, @Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize, @Query(value="includeDeleted") Boolean includeDeleted)
identifier
- identifier (required)offsetBy
- next page start offset for pagination (optional, default to 0)pageSize
- maximum number of records in each returned page (optional, default to 50)includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @GET(value="v1/sharedassessments") retrofit2.Call<AssessmentList> getSharedAssessments(@Query(value="offsetBy") Integer offsetBy, @Query(value="pageSize") Integer pageSize, @Query(value="tag") List<String> tag, @Query(value="includeDeleted") Boolean includeDeleted)
offsetBy
- next page start offset for pagination (optional, default to 0)pageSize
- maximum number of records in each returned page (optional, default to 50)tag
- One or more tags. Every resource that has at least one of the tags will be returned (resources do not need to match all tags). (optional)includeDeleted
- Should deleted items be returned in results? (optional, default to false)@Headers(value="Content-Type:application/json") @POST(value="v1/sharedassessments/{guid}/import") retrofit2.Call<Assessment> importSharedAssessment(@Path(value="guid") String guid, @Query(value="ownerId") String ownerId, @Query(value="newIdentifier") String newIdentifier)
guid
- A guid (required)ownerId
- The organizational ID the assessment should be imported under as the owning organization of the assessment (only members of that organization will be able to edit the assessment, though all users in an app context can see and schedule the assessment). (required)newIdentifier
- Upon importing this assessment, you can provide a new identifier for the assessment. (optional)@Headers(value="Content-Type:application/json") @POST(value="v1/sharedassessments/identifier:{assessmentId}/resources/import") retrofit2.Call<ExternalResourceList> importSharedAssessmentResource(@Path(value="assessmentId") String assessmentId, @Body List<String> externalResourceGUIDs)
assessmentId
- The identifier for a stream of assessment revisions (required)externalResourceGUIDs
- List of external resource GUIDs (required)@Headers(value="Content-Type:application/json") @POST(value="v1/sharedassessments/{guid}") retrofit2.Call<Assessment> updateSharedAssessment(@Path(value="guid") String guid, @Body Assessment assessment)
guid
- A guid (required)assessment
- Updated assessment (required)@Headers(value="Content-Type:application/json") @POST(value="v1/sharedassessments/identifier:{assessmentId}/resources/{guid}") retrofit2.Call<ExternalResource> updateSharedAssessmentResource(@Path(value="assessmentId") String assessmentId, @Path(value="guid") String guid, @Body ExternalResource externalResource)
assessmentId
- The identifier for a stream of assessment revisions (required)guid
- A guid (required)externalResource
- Assessment resource (required)Copyright © 2023 Sage Bionetworks. All rights reserved.