Interface CommentsApiCommentsListRequest

Request parameters for commentsList operation in CommentsApi.

CommentsApiCommentsListRequest

interface CommentsApiCommentsListRequest {
    filter?: string;
    frameId?: number;
    issueId?: number;
    jobId?: number;
    org?: string;
    orgId?: number;
    owner?: string;
    page?: number;
    pageSize?: number;
    search?: string;
    sort?: string;
    xOrganization?: string;
}

Properties

filter?: string

JSON Logic filter. This filter can be used to perform complex filtering by grouping rules. For example, using such a filter you can get all resources created by you: - {&quot;and&quot;:[{&quot;==&quot;:[{&quot;var&quot;:&quot;owner&quot;},&quot;<user>&quot;]}]} Details about the syntax used can be found at the link: https://jsonlogic.com/ Available filter_fields: [&#39;owner&#39;, &#39;id&#39;, &#39;issue_id&#39;, &#39;frame_id&#39;, &#39;job_id&#39;].

CommentsApiCommentsList

frameId?: number

A simple equality filter for the frame_id field

CommentsApiCommentsList

issueId?: number

A simple equality filter for the issue_id field

CommentsApiCommentsList

jobId?: number

A simple equality filter for the job_id field

CommentsApiCommentsList

org?: string

Organization unique slug

CommentsApiCommentsList

orgId?: number

Organization identifier

CommentsApiCommentsList

owner?: string

A simple equality filter for the owner field

CommentsApiCommentsList

page?: number

A page number within the paginated result set.

CommentsApiCommentsList

pageSize?: number

Number of results to return per page.

CommentsApiCommentsList

search?: string

A search term. Available search_fields: (&#39;owner&#39;,)

CommentsApiCommentsList

sort?: string

Which field to use when ordering the results. Available ordering_fields: [&#39;owner&#39;, &#39;id&#39;, &#39;issue_id&#39;, &#39;frame_id&#39;, &#39;job_id&#39;]

CommentsApiCommentsList

xOrganization?: string

Organization unique slug

CommentsApiCommentsList