Function getOrganization

getOrganization(
    client: Client,
    parameters: { organizationId: number },
    options?: RequestOptions,
): Promise<
    {
        _links?: { self?: string; [key: string]: unknown };
        created?: {
            epochMillis?: number;
            friendly?: string;
            iso8601?: string;
            jira?: string;
            [key: string]: unknown;
        };
        id?: string;
        name?: string;
        scimManaged?: boolean;
        uuid?: string;
        [key: string]: unknown;
    },
>
This method returns details of an organization. Use this method to get organization details whenever your application component is passed an organization ID but needs to display other organization details.

To get organization detail field values which are visible in Jira Service Management, see the Customer Service Management REST API.

Permissions required: Any

Response limitations: Customers can only retrieve organization of which they are members.
Parameters
- client: Client
- parameters: { organizationId: number }
  - organizationId: number
    
    The ID of the organization.
- Optionaloptions: RequestOptions
Returns Promise<
    {
        _links?: { self?: string; [key: string]: unknown };
        created?: {
            epochMillis?: number;
            friendly?: string;
            iso8601?: string;
            jira?: string;
            [key: string]: unknown;
        };
        id?: string;
        name?: string;
        scimManaged?: boolean;
        uuid?: string;
        [key: string]: unknown;
    },
>
- Defined in src/serviceDesk/api/organization.ts:93

Function getOrganization

Parameters

organizationId: number

Returns Promise< { _links?: { self?: string; [key: string]: unknown }; created?: { epochMillis?: number; friendly?: string; iso8601?: string; jira?: string; [key: string]: unknown; }; id?: string; name?: string; scimManaged?: boolean; uuid?: string; [key: string]: unknown; },>

Settings

Returns Promise<
{
_links?: { self?: string; [key: string]: unknown };
created?: {
epochMillis?: number;
friendly?: string;
iso8601?: string;
jira?: string;
[key: string]: unknown;
};
id?: string;
name?: string;
scimManaged?: boolean;
uuid?: string;
[key: string]: unknown;
},
>