public interface AssessmentsApi
Modifier and Type | Method and Description |
---|---|
retrofit2.Call<Assessment> |
createAssessment(Assessment assessment)
Create a new assessment.
|
retrofit2.Call<ExternalResource> |
createAssessmentResource(String assessmentId,
ExternalResource externalResource)
Create a new external resource link documenting an assessment
|
retrofit2.Call<Assessment> |
createAssessmentRevision(String guid,
Assessment assessment)
Create a new revision of an assessment.
|
retrofit2.Call<AssessmentConfig> |
customizeAssessmentConfig(String guid,
Object customizationUpdate)
Submit updates to the config that conform to the allowed customizations for the assessment.
|
retrofit2.Call<Message> |
deleteAssessment(String guid,
Boolean physical)
Delete an assessment revision.
|
retrofit2.Call<Message> |
deleteAssessmentResource(String assessmentId,
String guid,
Boolean physical)
Delete an external resource link documenting an assessment
|
retrofit2.Call<Assessment> |
getAssessmentByGUID(String guid)
Get a specific assessment revision.
|
retrofit2.Call<Assessment> |
getAssessmentById(String identifier,
Long revision)
Get an assessment revision by identifier and revision number.
|
retrofit2.Call<AssessmentConfig> |
getAssessmentConfig(String guid)
Get the JSON config for this assessment.
|
retrofit2.Call<ExternalResource> |
getAssessmentResource(String assessmentId,
String guid)
Get an assessment external resource description
|
retrofit2.Call<PagedExternalResourceList> |
getAssessmentResources(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> |
getAssessmentRevisionsByGUID(String guid,
Integer offsetBy,
Integer pageSize,
Boolean includeDeleted)
Get the revisions of an assessment with a specific identifier.
|
retrofit2.Call<AssessmentList> |
getAssessmentRevisionsById(String identifier,
Integer offsetBy,
Integer pageSize,
Boolean includeDeleted)
Get the revisions for an assessment by its identifier.
|
retrofit2.Call<AssessmentList> |
getAssessments(Integer offsetBy,
Integer pageSize,
List<String> tag,
Boolean includeDeleted)
Get assessments in the app context.
|
retrofit2.Call<Assessment> |
getLatestAssessmentRevision(String identifier)
Get the latest version of an assessment.
|
retrofit2.Call<Assessment> |
publishAssessment(String guid,
String newIdentifier)
Publish an assessment revision in the shared library.
|
retrofit2.Call<ExternalResourceList> |
publishAssessmentResource(String assessmentId,
List<String> externalResourceGUIDs)
Copy these resources to the shared assessments library.
|
retrofit2.Call<Assessment> |
updateAssessment(String guid,
Assessment assessment)
Update an assessment revision.
|
retrofit2.Call<AssessmentConfig> |
updateAssessmentConfig(String guid,
AssessmentConfig assessmentConfig)
Update the JSON config for this assessment.
|
retrofit2.Call<ExternalResource> |
updateAssessmentResource(String assessmentId,
String guid,
ExternalResource externalResource)
Update an external resource link documenting an assessment
|
@Headers(value="Content-Type:application/json") @POST(value="v1/assessments") retrofit2.Call<Assessment> createAssessment(@Body Assessment assessment)
assessment
- (required)@Headers(value="Content-Type:application/json") @POST(value="v1/assessments/identifier:{assessmentId}/resources") retrofit2.Call<ExternalResource> createAssessmentResource(@Path(value="assessmentId") String assessmentId, @Body ExternalResource externalResource)
assessmentId
- The identifier for a stream of assessment revisions (required)externalResource
- Assessment resource (required)@Headers(value="Content-Type:application/json") @POST(value="v1/assessments/{guid}/revisions") retrofit2.Call<Assessment> createAssessmentRevision(@Path(value="guid") String guid, @Body Assessment assessment)
guid
- A guid (required)assessment
- (required)@Headers(value="Content-Type:application/json") @POST(value="v1/assessments/{guid}/config/customize") retrofit2.Call<AssessmentConfig> customizeAssessmentConfig(@Path(value="guid") String guid, @Body Object customizationUpdate)
guid
- A guid (required)customizationUpdate
- (required)@Headers(value="Content-Type:application/json") @DELETE(value="v1/assessments/{guid}") retrofit2.Call<Message> deleteAssessment(@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/assessments/identifier:{assessmentId}/resources/{guid}") retrofit2.Call<Message> deleteAssessmentResource(@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/assessments/{guid}") retrofit2.Call<Assessment> getAssessmentByGUID(@Path(value="guid") String guid)
guid
- A guid (required)@Headers(value="Content-Type:application/json") @GET(value="v1/assessments/identifier:{identifier}/revisions/{revision}") retrofit2.Call<Assessment> getAssessmentById(@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/assessments/{guid}/config") retrofit2.Call<AssessmentConfig> getAssessmentConfig(@Path(value="guid") String guid)
guid
- A guid (required)@Headers(value="Content-Type:application/json") @GET(value="v1/assessments/identifier:{assessmentId}/resources/{guid}") retrofit2.Call<ExternalResource> getAssessmentResource(@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/assessments/identifier:{assessmentId}/resources") retrofit2.Call<PagedExternalResourceList> getAssessmentResources(@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/assessments/{guid}/revisions") retrofit2.Call<AssessmentList> getAssessmentRevisionsByGUID(@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/assessments/identifier:{identifier}/revisions") retrofit2.Call<AssessmentList> getAssessmentRevisionsById(@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/assessments") retrofit2.Call<AssessmentList> getAssessments(@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") @GET(value="v1/assessments/identifier:{identifier}") retrofit2.Call<Assessment> getLatestAssessmentRevision(@Path(value="identifier") String identifier)
identifier
- identifier (required)@Headers(value="Content-Type:application/json") @POST(value="v1/assessments/{guid}/publish") retrofit2.Call<Assessment> publishAssessment(@Path(value="guid") String guid, @Query(value="newIdentifier") String newIdentifier)
guid
- A guid (required)newIdentifier
- Upon publishing this assessment, you can provide a new identifier for the assessment. (optional)@Headers(value="Content-Type:application/json") @POST(value="v1/assessments/identifier:{assessmentId}/resources/publish") retrofit2.Call<ExternalResourceList> publishAssessmentResource(@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/assessments/{guid}") retrofit2.Call<Assessment> updateAssessment(@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/assessments/{guid}/config") retrofit2.Call<AssessmentConfig> updateAssessmentConfig(@Path(value="guid") String guid, @Body AssessmentConfig assessmentConfig)
guid
- A guid (required)assessmentConfig
- (required)@Headers(value="Content-Type:application/json") @POST(value="v1/assessments/identifier:{assessmentId}/resources/{guid}") retrofit2.Call<ExternalResource> updateAssessmentResource(@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.