Skip to content

user_namespace_map

Browse user namespace maps

Create

Path
POST /v7.0/user_namespace_maps
Description
Create user namespace map
Authentication required
yes
Scope
user_namespace_map#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
user_namespace_map
ParameterTypeRequiredDetails
user_namespace
UserNamespace
 Resource yes
label
Label
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
user_namespace_map
ParameterTypeDescription
id
Map ID
 Integer
user_namespace
UserNamespace
 Resource
label
Label
 String

Delete

Path
DELETE /v7.0/user_namespace_maps/{user_namespace_map_id}
Description
Delete user namespace map
Authentication required
yes
Scope
user_namespace_map#delete
Aliases
destroy
Blocking
no

Input parameters

No parameters.

Output parameters

No parameters.

Index

Path
GET /v7.0/user_namespace_maps
Description
List user namespace maps
Authentication required
yes
Scope
user_namespace_map#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
user_namespace_map
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
user
User
 Resource no
user_namespace
UserNamespace
 Resource no

Output parameters

Layout
object_list
Namespace
user_namespace_maps
ParameterTypeDescription
id
Map ID
 Integer
user_namespace
UserNamespace
 Resource
label
Label
 String

Show

Path
GET /v7.0/user_namespace_maps/{user_namespace_map_id}
Description
Authentication required
yes
Scope
user_namespace_map#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
user_namespace_map
ParameterTypeDescription
id
Map ID
 Integer
user_namespace
UserNamespace
 Resource
label
Label
 String

Update

Path
PUT /v7.0/user_namespace_maps/{user_namespace_map_id}
Description
Edit user namespace map
Authentication required
yes
Scope
user_namespace_map#update
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
user_namespace_map
ParameterTypeRequiredDetails
user_namespace
UserNamespace
 Resource yes
label
Label
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Output parameters

Layout
object
Namespace
user_namespace_map
ParameterTypeDescription
id
Map ID
 Integer
user_namespace
UserNamespace
 Resource
label
Label
 String

Subresources