Package com.seeq.api
Class AnnotationsApi
java.lang.Object
com.seeq.api.AnnotationsApi
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionArchive an annotationarchiveAnnotationWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Archive an annotationArchive an annotationvoid
corsImageProxy
(String accept, String imageUrl) void
corsImageProxyWithHeadersAndHttpInfo
(String accept, String imageUrl, Map<String, String> customHeaders) void
corsImageProxyWithHttpInfo
(String accept, String imageUrl) Create an annotationcreateAnnotationWithHeadersAndHttpInfo
(AnnotationInputV1 body, Map<String, String> customHeaders) Create an annotationCreate an annotationdeleteImage
(String id, String fileName) Delete an image from a journal entryDelete an image from a journal entrydeleteImageWithHttpInfo
(String id, String fileName) Delete an image from a journal entrygetAnnotation
(String id) Get an annotationGet a collection of annotationsgetAnnotationsWithHeadersAndHttpInfo
(List<String> annotates, String type, Integer offset, Integer limit, Map<String, String> customHeaders) Get a collection of annotationsGet a collection of annotationsgetAnnotationWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Get an annotationGet an annotationvoid
Get an image for a journal entryvoid
Get an image for a journal entryvoid
getImageWithHttpInfo
(String id, String fileName) Get an image for a journal entrylong
Mark the annotation as upgraded to CK Editor using the provided HTMLmigrateAnnotationToCkEditorWithHeadersAndHttpInfo
(String id, MigrateEditorInputV1 body, Map<String, String> customHeaders) Mark the annotation as upgraded to CK Editor using the provided HTMLMark the annotation as upgraded to CK Editor using the provided HTMLpublishReport
(String id) Publish a report so it cannot be changedpublishReportWithHeadersAndHttpInfo
(String id, Map<String, String> customHeaders) Publish a report so it cannot be changedPublish a report so it cannot be changedvoid
setApiClient
(ApiClient apiClient) void
setRetryTimeout
(long retryTimeout) updateAnnotation
(String id, AnnotationInputV1 body) Update an annotationupdateAnnotationWithHeadersAndHttpInfo
(String id, AnnotationInputV1 body, Map<String, String> customHeaders) Update an annotationUpdate an annotationuploadImage
(File file, String id) Upload an image for a journal entryUpload an image for a journal entryuploadImageWithHttpInfo
(File file, String id) Upload an image for a journal entry
-
Constructor Details
-
AnnotationsApi
public AnnotationsApi() -
AnnotationsApi
-
-
Method Details
-
setRetryTimeout
public void setRetryTimeout(long retryTimeout) -
getRetryTimeout
public long getRetryTimeout() -
getApiClient
-
setApiClient
-
archiveAnnotation
Archive an annotation- Parameters:
id
- ID of the annotation to archive (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
archiveAnnotationWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> archiveAnnotationWithHttpInfo(String id) throws ApiException Archive an annotation- Parameters:
id
- ID of the annotation to archive (required)- Throws:
ApiException
- if fails to make API call
-
archiveAnnotationWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> archiveAnnotationWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionArchive an annotation- Parameters:
id
- ID of the annotation to archive (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
corsImageProxy
- Parameters:
accept
- (optional)imageUrl
- (required)- Throws:
ApiException
- if fails to make API call
-
corsImageProxyWithHttpInfo
- Parameters:
accept
- (optional)imageUrl
- (required)- Throws:
ApiException
- if fails to make API call
-
corsImageProxyWithHeadersAndHttpInfo
public void corsImageProxyWithHeadersAndHttpInfo(String accept, String imageUrl, Map<String, String> customHeaders) throws ApiException- Parameters:
accept
- (optional)imageUrl
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
createAnnotation
Create an annotation- Parameters:
body
- Annotation information (required)- Returns:
- AnnotationOutputV1
- Throws:
ApiException
- if fails to make API call
-
createAnnotationWithHttpInfo
public ApiClient.ApiResponse<AnnotationOutputV1> createAnnotationWithHttpInfo(AnnotationInputV1 body) throws ApiException Create an annotation- Parameters:
body
- Annotation information (required)- Throws:
ApiException
- if fails to make API call
-
createAnnotationWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AnnotationOutputV1> createAnnotationWithHeadersAndHttpInfo(AnnotationInputV1 body, Map<String, String> customHeaders) throws ApiExceptionCreate an annotation- Parameters:
body
- Annotation information (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
deleteImage
Delete an image from a journal entry- Parameters:
id
- The ID of the Annotation that uses the image (required)fileName
- The file name of the image (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
deleteImageWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteImageWithHttpInfo(String id, String fileName) throws ApiException Delete an image from a journal entry- Parameters:
id
- The ID of the Annotation that uses the image (required)fileName
- The file name of the image (required)- Throws:
ApiException
- if fails to make API call
-
deleteImageWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> deleteImageWithHeadersAndHttpInfo(String id, String fileName, Map<String, String> customHeaders) throws ApiExceptionDelete an image from a journal entry- Parameters:
id
- The ID of the Annotation that uses the image (required)fileName
- The file name of the image (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getAnnotation
Get an annotation- Parameters:
id
- ID of the annotation to retrieve (required)- Returns:
- AnnotationOutputV1
- Throws:
ApiException
- if fails to make API call
-
getAnnotationWithHttpInfo
public ApiClient.ApiResponse<AnnotationOutputV1> getAnnotationWithHttpInfo(String id) throws ApiException Get an annotation- Parameters:
id
- ID of the annotation to retrieve (required)- Throws:
ApiException
- if fails to make API call
-
getAnnotationWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AnnotationOutputV1> getAnnotationWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionGet an annotation- Parameters:
id
- ID of the annotation to retrieve (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getAnnotations
public AnnotationListOutputV1 getAnnotations(List<String> annotates, String type, Integer offset, Integer limit) throws ApiException Get a collection of annotations- Parameters:
annotates
- A list of item IDs that will filter the annotations returned to only those that annotate the specified items. (optional)type
- The type of annotations to return, either Report or Journal (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Returns:
- AnnotationListOutputV1
- Throws:
ApiException
- if fails to make API call
-
getAnnotationsWithHttpInfo
public ApiClient.ApiResponse<AnnotationListOutputV1> getAnnotationsWithHttpInfo(List<String> annotates, String type, Integer offset, Integer limit) throws ApiException Get a collection of annotations- Parameters:
annotates
- A list of item IDs that will filter the annotations returned to only those that annotate the specified items. (optional)type
- The type of annotations to return, either Report or Journal (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)- Throws:
ApiException
- if fails to make API call
-
getAnnotationsWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AnnotationListOutputV1> getAnnotationsWithHeadersAndHttpInfo(List<String> annotates, String type, Integer offset, Integer limit, Map<String, String> customHeaders) throws ApiExceptionGet a collection of annotations- Parameters:
annotates
- A list of item IDs that will filter the annotations returned to only those that annotate the specified items. (optional)type
- The type of annotations to return, either Report or Journal (optional)offset
- The pagination offset, the index of the first collection item that will be returned in this page of results (optional, default to 0)limit
- The pagination limit, the total number of collection items that will be returned in this page of results (optional, default to 40)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
getImage
Get an image for a journal entry- Parameters:
id
- The ID of the Annotation that uses the image (required)fileName
- The file name of the image (required)- Throws:
ApiException
- if fails to make API call
-
getImageWithHttpInfo
Get an image for a journal entry- Parameters:
id
- The ID of the Annotation that uses the image (required)fileName
- The file name of the image (required)- Throws:
ApiException
- if fails to make API call
-
getImageWithHeadersAndHttpInfo
public void getImageWithHeadersAndHttpInfo(String id, String fileName, Map<String, String> customHeaders) throws ApiExceptionGet an image for a journal entry- Parameters:
id
- The ID of the Annotation that uses the image (required)fileName
- The file name of the image (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
migrateAnnotationToCkEditor
public StatusMessageBase migrateAnnotationToCkEditor(String id, MigrateEditorInputV1 body) throws ApiException Mark the annotation as upgraded to CK Editor using the provided HTML- Parameters:
id
- The Seeq ID for the report (required)body
- (required)- Returns:
- StatusMessageBase
- Throws:
ApiException
- if fails to make API call
-
migrateAnnotationToCkEditorWithHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> migrateAnnotationToCkEditorWithHttpInfo(String id, MigrateEditorInputV1 body) throws ApiException Mark the annotation as upgraded to CK Editor using the provided HTML- Parameters:
id
- The Seeq ID for the report (required)body
- (required)- Throws:
ApiException
- if fails to make API call
-
migrateAnnotationToCkEditorWithHeadersAndHttpInfo
public ApiClient.ApiResponse<StatusMessageBase> migrateAnnotationToCkEditorWithHeadersAndHttpInfo(String id, MigrateEditorInputV1 body, Map<String, String> customHeaders) throws ApiExceptionMark the annotation as upgraded to CK Editor using the provided HTML- Parameters:
id
- The Seeq ID for the report (required)body
- (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
publishReport
Publish a report so it cannot be changed- Parameters:
id
- ID of the report to publish (required)- Returns:
- AnnotationOutputV1
- Throws:
ApiException
- if fails to make API call
-
publishReportWithHttpInfo
public ApiClient.ApiResponse<AnnotationOutputV1> publishReportWithHttpInfo(String id) throws ApiException Publish a report so it cannot be changed- Parameters:
id
- ID of the report to publish (required)- Throws:
ApiException
- if fails to make API call
-
publishReportWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AnnotationOutputV1> publishReportWithHeadersAndHttpInfo(String id, Map<String, String> customHeaders) throws ApiExceptionPublish a report so it cannot be changed- Parameters:
id
- ID of the report to publish (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
updateAnnotation
Update an annotation- Parameters:
id
- ID of the annotation to update (required)body
- Annotation input (required)- Returns:
- AnnotationOutputV1
- Throws:
ApiException
- if fails to make API call
-
updateAnnotationWithHttpInfo
public ApiClient.ApiResponse<AnnotationOutputV1> updateAnnotationWithHttpInfo(String id, AnnotationInputV1 body) throws ApiException Update an annotation- Parameters:
id
- ID of the annotation to update (required)body
- Annotation input (required)- Throws:
ApiException
- if fails to make API call
-
updateAnnotationWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AnnotationOutputV1> updateAnnotationWithHeadersAndHttpInfo(String id, AnnotationInputV1 body, Map<String, String> customHeaders) throws ApiExceptionUpdate an annotation- Parameters:
id
- ID of the annotation to update (required)body
- Annotation input (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-
uploadImage
Upload an image for a journal entry- Parameters:
file
- (optional)id
- The ID of the Annotation that will use the image (required)- Returns:
- AnnotationImageLinkOutputV1
- Throws:
ApiException
- if fails to make API call
-
uploadImageWithHttpInfo
public ApiClient.ApiResponse<AnnotationImageLinkOutputV1> uploadImageWithHttpInfo(File file, String id) throws ApiException Upload an image for a journal entry- Parameters:
file
- (optional)id
- The ID of the Annotation that will use the image (required)- Throws:
ApiException
- if fails to make API call
-
uploadImageWithHeadersAndHttpInfo
public ApiClient.ApiResponse<AnnotationImageLinkOutputV1> uploadImageWithHeadersAndHttpInfo(File file, String id, Map<String, String> customHeaders) throws ApiExceptionUpload an image for a journal entry- Parameters:
file
- (optional)id
- The ID of the Annotation that will use the image (required)customHeaders
- a map with custom headers for the HTTP request (required)- Throws:
ApiException
- if fails to make API call
-