ContentWorkspace

Represents a content library. This object is available in versions 17.0 and later.
Note

Note

This object does not apply to personal libraries.

Supported Calls

create(), delete(), describeSObjects(), query(), retrieve(), update()

Note

Note

create( ), update( ) and delete( ) on ContentWorkspace are supported in API version 40.0 and later only.

Special Access Rules

Fields

Field Details
DefaultRecordTypeId
Type
reference
Properties
Filter, Nillable
Description
ID of the default content type for the library. Content types are the containers for custom fields in Salesforce CRM Content.
Description
Type
textarea
Properties
Create, Filter, Nillable,Update
Description
Text description of the content library.
DeveloperName
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The unique name of the library in the API. Allows a link to the library to be packaged when an asset file is added to a package. Although libraries are not a packageable entity, references to libraries with a developer name will be included in the package when asset files are packaged. These links can then be restored in the target org.
This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. Label is Unique Name.
This field is available in API version 39.0 and later.
IsRestrictContentTypes
Type
boolean
Properties
Defaulted on create, Filter
Description
Read only. Indicates whether content types have been restricted (true) or not (false).
IsRestrictLinkedContentTypes
Type
boolean
Properties
Defaulted on create, Filter
Description
Read only. Indicates whether linked content types have been restricted (true) or not (false).
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the library.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The unique name of the library in the API. Allows a link to the library to be packaged when an asset file is added to a package. Limit: 15 characters. This field is available in API version 39.0 and later.
RootContentFolderId
Type
reference
Properties
Filter, Group, Nillable, Sort
Description
ID of root folder of the library. This field is available in API version 39.0 and later.
ShouldAddCreatorMembership
Type
boolean
Properties
Create, Defaulted on create, Group
Description
Automatically create a library membership for the user creating the library. Please note this field is not meant for query and always returns false in query. This field is available in API version 40.0 and later.
TagModel
Type
picklist
Properties
Defaulted on create, Filter, Nillable, Restricted picklist
Description
The type of tagging assigned to a library. Valid values are:
  • U — Unrestricted. No restrictions on tagging. Users can enter any tag when publishing or editing content.
  • G — Guided. Users can enter any tag when publishing or editing content, but they are also offered a list of suggested tags.
  • R — Restricted. Users must choose from a list of suggested tabs.
WorkspaceImageId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
ID of a library image. Image files can be assigned to libraries for branding and easy identification. Library image is visible to all users, even if they are not library members. This field is available in API version 43.0 and later.
WorkspaceType
Type
picklist
Properties
Filter, Group, Nillable, Restricted picklist, Sort
Description
Differentiates between different types of libraries. Valid values are:
  • R — Regular library
  • B — Org asset library
This field is available in API version 39.0 and later.

Usage

Use this object to query libraries to find out where documents can be published.

If the content type is not specified when publishing a new version into a library, it will be determined by the DefaultRecordTypeId of the primary library.

As of 40.0, you can create, update, or delete a library via the API.

See Also