On this page
Changes in data types
Branch (output only)
Name | Type | Status | Remark |
---|---|---|---|
createdDate | Integer | Added | The date created. |
propagateToChilds | Boolean | Added | Indicate whether metadata entries are propagated to child branches. |
removed | Boolean | Added | Indicate if the branch is removed. |
PermissionInfo and affected URLs
Name | Type | Status | Remark |
---|---|---|---|
protectedType | String | Removed | Use protectedTypes. |
protectedTypes | String[] | Added | A list of protected types supported by this permission. |
protectedTypeDisplayName | String | Value changed | Display a name of the protected type, separated by a ‘|’ mark, e.g., “resource|category”. |
The affected URLs are as follows:
- /admin/roles
- /admin/permissions
- /resources/{resourceId}/roles
- /workspaces/{workspacecId}/resources/{resourceId}/roles
ProtectedObjectInfo and affected URLs
Name | Type | Status | Remark |
---|---|---|---|
containerId | string/UUID | Added | A container ID of the protected object (support only the current version), “eb0880d8-18a1-4761-8134-fae25c794326”. |
The affected URLs are as follows:
- /admin/usergroups?includeBody=true
- /admin/users/{username}
- /admin/users/{username}/roles
LdapPost
Name | Type | Status | Remark |
---|---|---|---|
environment.usergroup_query | String | Added | A query string for retrieving user groups from LDAP. |
The affected URL is as follows:
- /admin/ldaps
LdapImportUser
Name | Type | Status | Remark |
---|---|---|---|
group | Boolean | Added | True or false to indicate whether the group is imported by default in case both the user and user group have the same name. |
The affected URL is as follows:
- /osmc/admin/ldaps/{ldapId}/import/{username} - POST
Assignees
Define a new type for URLs.
The affected URLs are as follows:
- /osmc/resources/{resourceId}/roles/{roleId}
- /osmc/workspaces/{workspaceId}/resources/{resourceId}/roles/{roleId}
- /osmc/workspaces/{workspaceId}/roles/{roleId}
URLs Relocated
From | To | Remark |
---|---|---|
/osmc/admin/users/currentUser | /osmc/admin/currentUser | Response status is changed from 301 to 307. |
New URLs
Read-only branch permission
- /osmc/admin/usergroups/{usergroupId}/resources/{resourceId}/branches/readonly
- /osmc/admin/users/{username}/resources/{resourceId}/branches/readonly
CRUD is for read-only branch settings
Category-level permission
- /osmc/workspaces/{workspaceId}/roles
- /osmc/workspaces/{workspaceId}/roles/{roleId}
- /osmc/workspaces/{workspaceId}/roles/{roleId}/usergroups
- /osmc/workspaces/{workspaceId}/roles/{roleId}/usergroups/{usergroupId}
- /osmc/workspaces/{workspaceId}/roles/{roleId}/users
- /osmc/workspaces/{workspaceId}/roles/{roleId}/users/{username}
API Documentation (for more clarified information)
The following changes are clarifications for existing APIs. Types defined in the Swagger document are updated, but APIs are not changed.
- /osmc/admin/ldaps/{ldapId}/resync/usergroups
PATCH
Name
Changed element
From
To
all
Type
String
Boolean
includeBody
Type
String
Boolean
- /osmc/admin/ldaps/{ldapId}/resync/users
PATCH
Name
Changed element
From
To
all
Type
String
Boolean
includeBody
Type
String
Boolean
/osmc/admin/permissions
GETName
Changed element
From
To
resourceScope
Type
String
Boolean
/osmc/admin/usergroups
GETName
Changed element
From
To
includeBody
Type
String
Boolean
PUT
Name
Changed element
From
To
includeNew
Type
String
Boolean
/osmc/admin/usergroups/{usergroupId}
GETName
Changed element
From
To
filter
Type
String
Boolean
/osmc/admin/usergroups/{usergroupId}/roles
GETName
Changed element
From
To
resourceName
Type
String
Boolean
filter
Type
String
Boolean
/osmc/admin/users
GETName
Changed element
From
To
includeBody
Type
String
Boolean
group
Type
String
Boolean
/osmc/admin/users/{username}
GETName
Changed element
From
To
permission
Type
String
Boolean
group
Type
String
Boolean
userGroups (output)
Type
String[]
UserGroup[] (ID only by default).
/osmc/admin/users/{username}/roles
GETName
Changed element
From
To
resourceName
Type
String
Boolean
filter
Type
String
Boolean
/osmc/resources
GETName
Changed element
From
To
includeBody
Type
String
Boolean
includeRemovedResource
Type
String
Boolean
/osmc/resources/{resourceId}/artifacts/{artifact}
/osmc/resources/{resourceId}/branches/{branchId}/artifacts/{artifact}
/osmc/resources/{resourceId}/branches/{branchId}/revisions/{revision}/artifacts/{artifact}
/osmc/resources/{resourceId}/revisions/{revision}/artifacts/{artifact}
/osmc/workspaces/{workspaceId}/resources/{resourceId}/artifacts/{artifact}
/osmc/workspaces/{workspaceId}/resources/{resourceId}/branches/{branchId}/revisions/{revision}/artifacts/{artifact}
/osmc/workspaces/{workspaceId}/resources/{resourceId}/revisions/{revision}/artifacts/{artifact}GET
Name
Changed element
From
To
download
Type
String
Boolean
/osmc/resources/{resourceId}/branches/{branchId}/elements
/osmc/resources/{resourceId}/branches/{branchId}/elements/{elementId}
/osmc/resources/{resourceId}/elements
/osmc/resources/{resourceId}/elements/{elementId}
/osmc/workspaces/{workspaceId}/resources/{resourceId}/branches/{branchId}/elements
/osmc/workspaces/{workspaceId}/resources/{resourceId}/branches/{branchId}/elements/{elementId}
/osmc/workspaces/{workspaceId}/resources/{resourceId}/elements
/osmc/workspaces/{workspaceId}/resources/{resourceId}/elements/{elementId}
PUT
Replace all the attributes of an element in a particular branch so that PUT at the URL updates the element specified by elementId. The specified attributes are updated while attributes not included in the request are reset. New values are specified in kerml:esiData./osmc/resources/{resourceId}/branches/{branchId}/locks
DELETEName
Changed element
From
To
userNames
Type
String
String[]
/osmc/resources/{resourceId}/branches/{branchId}/locks
/osmc/workspaces/{workspaceId}/resources/{resourceId}/branches/{branchId}/locks
/osmc/workspaces/{workspaceId}/resources/{resourceId}/locks
GETChanged element
From
To
Response type
#/definitions/osmc/admin/workspaces/workspaceID/resources/resourceID/locks/get
#/definitions/LockResults
/osmc/resources/{resourceId}/locks
DELETEName
Changed Element
From
To
userNames
Type
#/definitions/osmc/admin/workspaces/workspaceID/resources/resourceID/locks/delete
#/definitions/arrayOfString
/osmc/resources/{resourceId}/locks
GETChanged Element
From
To
Response Type
#/definitions/osmc/admin/workspaces/workspaceID/resources/resourceID/locks/get
#/definitions/LockResults
/osmc/resources/{resourceId}/revisiondiff
/osmc/workspaces/{workspaceId}/resources/{resourceId}/revisiondiff
GETName
Changed element
From
To
source
Type
String
Integer
target
Type
String
Integer
/osmc/resources/{resourceId}/revisions
/osmc/workspaces/{workspaceId}/resources/{resourceId}/revisions
GETName
Changed element
From
To
includeBody
Type
String
Boolean
page
Type
String
Integer
items
Type
String
Integer
search
Type
NA
String
/osmc/workspaces
GETName
Changed Element
From
To
includeBody
Type
String
Boolean
PUT
Name
Changed Element
From
To
includeNew
Type
String
Boolean
/osmc/workspaces/{workspaceId}/resources
GET
Name
Changed Element
From
To
includeBody
Type
String
Boolean
includeRemovedResource
Type
String
Boolean
/osmc/workspaces/{workspaceId}/resources/{resourceId}/branches/{branchId}/locks
/osmc/workspaces/{workspaceId}/resources/{resourceId}/locksDELETE
Name
Changed element
From
To
userNames
Type
#/definitions/osmc/admin/workspaces/workspaceID/resources/resourceID/locks/delete
#/definitions/arrayOfString