Class ProjectKeyAndNameValidationService

This resource provides validation for project keys and names.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation

Hierarchy

CommonHttpService
- ProjectKeyAndNameValidationService

Index

Constructors

Methods

getValidProjectKey getValidProjectName validateProjectKey initialize

Constructors

constructor

new ProjectKeyAndNameValidationService(getClientInstance): ProjectKeyAndNameValidationService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns ProjectKeyAndNameValidationService
Inherited from CommonHttpService.constructor

Methods

getValidProjectKey

getValidProjectKey(params?): Promise<string>
Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.

Permissions required: None.
Parameters
- params: {
  key?: string;
  } = {}
  - Optionalkey?: string
    The project key.
Returns Promise<string>
Returned if the request is successful.

example:
```
"VPNE"
```
Path
GET /rest/api/3/projectvalidate/validProjectKey

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation#api-rest-api-3-projectvalidate-validprojectkey-get

getValidProjectName

getValidProjectName(params): Promise<string>
Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.

Permissions required: None.
Parameters
- params: {
  name: string;
  }
  - name: string
    The project name.
Returns Promise<string>
Returned if the request is successful.

example:
```
"Valid Project Name Example"
```
Path
GET /rest/api/3/projectvalidate/validProjectName

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation#api-rest-api-3-projectvalidate-validprojectname-get

validateProjectKey

validateProjectKey(params?): Promise<ErrorCollection>
Validates a project key by confirming the key is a valid string and not in use.

Permissions required: None.
Parameters
- params: {
  key?: string;
  } = {}
  - Optionalkey?: string
    The project key.
Returns Promise<ErrorCollection>
Returned if the request is successful.

example:
```
{
  "errorMessages": [],
  "errors": {
    "projectKey": "A project with that project key already exists."
  }
}
```
Path
GET /rest/api/3/projectvalidate/key @scopes-current read:jira-work @scopes-beta read:project:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-key-and-name-validation#api-rest-api-3-projectvalidate-key-get

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize