Versions Compared

Old Version 1

changes.mady.by.user user-52ec1

Saved on

compared with

New Version Current

changes.mady.by.user user-52ec1

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Content layer
id2102576462
  • search


New URLs

All read-only branches permission for a user

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 setting 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. 

branches for a user.

All read-only branches permission for a user group

  • /osmc/admin/ldaps/{ldapId}/resync/usergroups

    PATCH

/osmc/admin/ldaps/{ldapId}/resync/users

PATCH

/osmc/admin/permissions
GET

/osmc/admin/usergroups
GET

PUT

/osmc/admin/usergroups/{usergroupId}GET

/osmc/admin/usergroups/{usergroupId}/roles
GET

/osmc/admin/users
GET

/osmc/admin/users/{username}
GET

/osmc/admin/users/{username}/roles
GET

/osmc/resources
GET

/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

  • /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
    DELETE

    /osmc/resources/{resourceId}/branches/{branchId}/locks
    /osmc/workspaces/{workspaceId}/resources/{resourceId}/branches/{branchId}/locks
    /osmc/workspaces/{workspaceId}/resources/{resourceId}/locks
    GET

    /osmc/resources/{resourceId}/locks
    DELETE

    /osmc/resources/{resourceId}/locks
    GET

    /osmc/resources/{resourceId}/revisiondiff
    /osmc/workspaces/{workspaceId}/resources/{resourceId}/revisiondiff
    GET

    /osmc/resources/{resourceId}/revisions
    /osmc/workspaces/{workspaceId}/resources/{resourceId}/revisions
    GET

    /osmc/workspaces
    GET

    PUT

    /osmc/workspaces/{workspaceId}/resources

    GET

    /osmc/workspaces/{workspaceId}/resources/{resourceId}/branches/{branchId}/locks
    /osmc/workspaces/{workspaceId}/resources/{resourceId}/locks

    DELETE

    #/definitions/arrayOfString

    CRUD for setting read-only branches for a user group.

    Content column
    id2102576476
    Content block
    id2102576459

    On this page

    Table of Contents

    Content block
    id2102576466

    Changes in

    Data TypesBranch (output only)

    data types


    Workspace

    Name

    Type

    Status

    Remark

    createdDate

    ldp:hasMemberRelation

    		Integer

    String

    		AddedThe date created.
    propagateToChildsBooleanAddedIndicate whether metadata entries are propagated to child branches. 
    removedBooleanAddedIndicate if the branch is removed.

    PermissionInfo and affected URLs

    Type changed

    Change kerml:resources to

    [

    "kerml:resources", 

    "kerml:categories"

    ],

    kerml:categories

    UUID

    NameTypeStatusRemark
    protectedTypeStringRemovedUse protectedTypes.
    protectedTypesString

    []

    Added

    		A list of protected types supported by this permission.

    An array of nested category IDs.

    kerml:parentID

    protectedTypeDisplayName

    String

    		Value changedDisplay a name of the protected type, separated by a ‘|’ mark, e.g., “resource|category”.

    The affected URLs are as follows:

    Added

    A UUID of its parent.

    Affected URLs:

    • /workspaces?includeBody=true
    • /workspaces/{workspaceId}
    • /admin/roles
    • /admin/permissions
    • /resources/{resourceId}/roles
    • /workspaces/{workspacecIdworkspaceId}/resources/{resourceId}/roles
    ProtectedObjectInfo and affected URLs


    Audit resource

    Name

    Type

    Status

    Remark

    containerIdstring/UUIDAddedA container ID of the protected object (support only the current version), “eb0880d8-18a1-4761-8134-fae25c794326”.

    data/assigneeRoles/assigneeUsers/scopeType

    String

    Value changed

    The Custom scope type is changed to Resource.

    Affected URLThe affected URLs are as follows:

    • /admin/usergroups?includeBody=true
    • /admin/users/{username}
    • /admin/users/{username}/roles

    LdapPost

    • audit/resources


    New query parameter

    Name

    Type

    Status

    Remark

    environment.usergroup_query

    ldapAttribute

    String

    Added

    		A query string for retrieving user groups from LDAP.
    The affected URL is

    An LDAP field to search for. Possible values are as follows:

    • /admin/ldaps

    LdapImportUser

    NameTypeStatusRemark
    groupBooleanAddedTrue or false to indicate whether the group is imported by default in case both the user and user group have the same name.
    • name
    • fullname
    • phone
    • email
    • department
    • usergroup
    • description
    • query

    Affected URL:

    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

    FromToRemark
    /osmc/admin/users/currentUser/osmc/admin/currentUserResponse status is changed from 301 to 307.

    Name

    Changed element

    From

    To

    all

    Type

    String

    Boolean

    includeBody

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    all

    Type

    String

    Boolean

    includeBody

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    resourceScope

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    includeBody

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    includeNew

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    filter

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    resourceName

    Type

    String

    Boolean

    filter

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    includeBody

    Type

    String

    Boolean

    group

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    permission

    Type

    String

    Boolean

    group

    Type

    String

    Boolean

    userGroups (output)

    Type

    String[]

    UserGroup[] (ID only by default).

    Name

    Changed element

    From

    To

    resourceName

    Type

    String

    Boolean

    filter

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    includeBody

    Type

    String

    Boolean

    includeRemovedResource

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    download

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    userNames

    Type

    String

    String[]

    Changed element

    From

    To

    Response type

    #/definitions/osmc/admin/workspaces/workspaceID/resources/resourceID/locks/get

    #/definitions/LockResults

    Name

    Changed Element

    From

    To

    userNames

    Type

    #/definitions/osmc/admin/workspaces/workspaceID/resources/resourceID/locks/delete

    #/definitions/arrayOfString

    Changed Element

    From

    To

    Response Type

    #/definitions/osmc/admin/workspaces/workspaceID/resources/resourceID/locks/get

    #/definitions/LockResults

    Name

    Changed element

    From

    To

    source

    Type

    String

    Integer

    target

    Type

    String

    Integer

    Name

    Changed element

    From

    To

    includeBody

    Type

    String

    Boolean

    page

    Type

    String

    Integer

    items

    Type

    String

    Integer

    search

    Type

    NA

    String

    Name

    Changed Element

    From

    To

    includeBody

    Type

    String

    Boolean

    Name

    Changed Element

    From

    To

    includeNew

    Type

    String

    Boolean

    Name

    Changed Element

    From

    To

    includeBody

    Type

    String

    Boolean

    includeRemovedResource

    Type

    String

    Boolean

    Name

    Changed element

    From

    To

    userNames

    Type

    #/definitions/osmc/admin/workspaces/workspaceID/resources/resourceID/locks/delete