jira.js
    Preparing search index...

    Function findObjectsByAql

    • Fetch Objects by AQL

      Parameters

      • client: Client
      • parameters: {
            includeAttributes?: boolean;
            maxResults?: number;
            qlQuery: string;
            startAt?: number;
        }
        • OptionalincludeAttributes?: boolean

          Should the objects attributes be included in the response. If this parameter is false only the information on the object will be returned and the object attributes will not be present

        • OptionalmaxResults?: number

          The maximum number of objects to return in this page of results. Actual number of results may be less, for example, if the last page of results is returned.

        • qlQuery: string

          The AQL that will fetch the objects.

        • OptionalstartAt?: number

          The starting index for the next page of results

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              isLast: boolean;
              last: boolean;
              maxResults: number;
              objectTypeAttributes: {
                  additionalValue?: string;
                  defaultType?: | { id: -1; name: "None"; [key: string]: unknown }
                  | { id: 0; name: "Text"; [key: string]: unknown }
                  | { id: 1; name: "Integer"; [key: string]: unknown }
                  | { id: 2; name: "Boolean"; [key: string]: unknown }
                  | { id: 3; name: "Double"; [key: string]: unknown }
                  | { id: 4; name: "Date"; [key: string]: unknown }
                  | { id: 5; name: "Time"; [key: string]: unknown }
                  | { id: 6; name: "DateTime"; [key: string]: unknown }
                  | { id: 7; name: "Url"; [key: string]: unknown }
                  | { id: 8; name: "Email"; [key: string]: unknown }
                  | { id: 9; name: "Textarea"; [key: string]: unknown }
                  | { id: 10; name: "Select"; [key: string]: unknown }
                  | { id: 11; name: "IP Address"; [key: string]: unknown };
                  description?: string;
                  editable?: boolean;
                  globalId: string;
                  hidden?: boolean;
                  id: string;
                  includeChildObjectTypes?: boolean;
                  indexed: boolean;
                  label: boolean;
                  maximumCardinality?: number;
                  minimumCardinality?: number;
                  name?: string;
                  objectType?: {
                      abstractObjectType: boolean;
                      created: Date;
                      description?: string;
                      globalId: string;
                      icon: {
                          id: string;
                          name: string;
                          url16: string;
                          url48: string;
                          [key: string]: unknown;
                      };
                      id: string;
                      inherited: boolean;
                      name: string;
                      objectCount: number;
                      objectSchemaId: string;
                      parentObjectTypeId?: number;
                      parentObjectTypeInherited: boolean;
                      position: number;
                      type?: number;
                      updated: Date;
                      workspaceId: string;
                      [key: string]: unknown;
                  };
                  options?: string;
                  position: number;
                  qlQuery?: string;
                  referenceObjectType?: {
                      abstractObjectType: boolean;
                      created: Date;
                      description?: string;
                      globalId: string;
                      icon: {
                          id: string;
                          name: string;
                          url16: string;
                          url48: string;
                          [key: string]: unknown;
                      };
                      id: string;
                      inherited: boolean;
                      name: string;
                      objectCount: number;
                      objectSchemaId: string;
                      parentObjectTypeId?: number;
                      parentObjectTypeInherited: boolean;
                      position: number;
                      type?: number;
                      updated: Date;
                      workspaceId: string;
                      [key: string]: unknown;
                  };
                  referenceObjectTypeId?: string;
                  referenceType?: {
                      cdmData?: {
                          types?: {
                              key?: ...;
                              opinionated?: ...;
                              version?: ...;
                              [key: ...]: ...;
                          }[];
                          [key: string]: unknown;
                      };
                      color?: string;
                      description?: string;
                      globalId: string;
                      id?: string;
                      name: string;
                      objectSchemaId?: string;
                      url16?: string;
                      workspaceId: string;
                      [key: string]: unknown;
                  };
                  regexValidation?: string;
                  removable?: boolean;
                  sortable?: boolean;
                  suffix?: string;
                  summable?: boolean;
                  system?: boolean;
                  type?: number;
                  typeValue?: string;
                  typeValueMulti?: string[];
                  uniqueAttribute?: boolean;
                  workspaceId: string;
                  [key: string]: unknown;
              }[];
              startAt: number;
              values: {
                  _links: { self: string; [key: string]: unknown };
                  attributes?: {
                      objectAttributeValues: {
                          additionalValue?: string;
                          displayValue: string;
                          group?: { avatarUrl: ...; name: ...; [key: ...]: ... };
                          referencedObject?: Record<(...), (...)>;
                          searchValue?: string;
                          status?: {
                              category: ...;
                              description?: ...;
                              id: ...;
                              name: ...;
                              objectSchemaId?: ...;
                              [key: ...]: ...;
                          };
                          user?: {
                              avatarUrl?: ...;
                              displayName?: ...;
                              emailAddress?: ...;
                              html?: ...;
                              isDeleted?: ...;
                              key?: ...;
                              lastSeenVersion?: ...;
                              name?: ...;
                              renderedLink?: ...;
                              self?: ...;
                              [key: ...]: ...;
                          };
                          value?: string
                          | Date;
                          [key: string]: unknown;
                      }[];
                      objectTypeAttribute?: {
                          additionalValue?: string;
                          defaultType?: | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... }
                          | { id: ...; name: ...; [key: ...]: ... };
                          description?: string;
                          editable?: boolean;
                          globalId: string;
                          hidden?: boolean;
                          id: string;
                          includeChildObjectTypes?: boolean;
                          indexed: boolean;
                          label: boolean;
                          maximumCardinality?: number;
                          minimumCardinality?: number;
                          name?: string;
                          objectType?: {
                              abstractObjectType: ...;
                              created: ...;
                              description?: ...;
                              globalId: ...;
                              icon: ...;
                              id: ...;
                              inherited: ...;
                              name: ...;
                              objectCount: ...;
                              objectSchemaId: ...;
                              parentObjectTypeId?: ...;
                              parentObjectTypeInherited: ...;
                              position: ...;
                              type?: ...;
                              updated: ...;
                              workspaceId: ...;
                              [key: ...]: ...;
                          };
                          options?: string;
                          position: number;
                          qlQuery?: string;
                          referenceObjectType?: {
                              abstractObjectType: ...;
                              created: ...;
                              description?: ...;
                              globalId: ...;
                              icon: ...;
                              id: ...;
                              inherited: ...;
                              name: ...;
                              objectCount: ...;
                              objectSchemaId: ...;
                              parentObjectTypeId?: ...;
                              parentObjectTypeInherited: ...;
                              position: ...;
                              type?: ...;
                              updated: ...;
                              workspaceId: ...;
                              [key: ...]: ...;
                          };
                          referenceObjectTypeId?: string;
                          referenceType?: {
                              cdmData?: ...;
                              color?: ...;
                              description?: ...;
                              globalId: ...;
                              id?: ...;
                              name: ...;
                              objectSchemaId?: ...;
                              url16?: ...;
                              workspaceId: ...;
                              [key: ...]: ...;
                          };
                          regexValidation?: string;
                          removable?: boolean;
                          sortable?: boolean;
                          suffix?: string;
                          summable?: boolean;
                          system?: boolean;
                          type?: number;
                          typeValue?: string;
                          typeValueMulti?: (...)[];
                          uniqueAttribute?: boolean;
                          workspaceId: string;
                          [key: string]: unknown;
                      };
                      objectTypeAttributeId: string;
                      workspaceId: string;
                      [key: string]: unknown;
                  }[];
                  avatar: {
                      avatarUUID?: string;
                      globalId: string;
                      id?: string;
                      objectId: string;
                      url144: string;
                      url16: string;
                      url288: string;
                      url48: string;
                      url72: string;
                      workspaceId: string;
                      [key: string]: unknown;
                  };
                  created: Date;
                  globalId: string;
                  hasAvatar: boolean;
                  id: string;
                  label: string;
                  objectKey: string;
                  objectType: {
                      abstractObjectType: boolean;
                      created: Date;
                      description?: string;
                      globalId: string;
                      icon: {
                          id: string;
                          name: string;
                          url16: string;
                          url48: string;
                          [key: string]: unknown;
                      };
                      id: string;
                      inherited: boolean;
                      name: string;
                      objectCount: number;
                      objectSchemaId: string;
                      parentObjectTypeId?: number;
                      parentObjectTypeInherited: boolean;
                      position: number;
                      type?: number;
                      updated: Date;
                      workspaceId: string;
                      [key: string]: unknown;
                  };
                  timestamp: number;
                  updated: Date;
                  workspaceId: string;
                  [key: string]: unknown;
              }[];
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility