Record Management

In enterprise content management (ECM) scenarios, records are an important element within a document lifecycle and a company's compliance policies. Not only documents but actually items.
When declared as a record a document or item can't be later changed or moved without undeclaring. This guarantees integrity.
REST API in terms of managing classic in-place records is limited, you can only retrieve record status from item metadata. Item's OData__vti_ItemDeclaredRecord property tells was an item declared as a record and when. The field is a date-time value, empty means item is not a record.
We would not be we if didn't add an extension with allows Gosip to declare, undeclare and declare with a declaration date. To workaround REST's limitation, these functionality is achieved by corresponding CSOM calls. What's great is that Gosip abstracts for you such a nuance providing methods which under-the-hood details are interesting but not necessarily should be known by a library consumer.
It's important to notice that in-place record management requires some configuration which is not the topic of this article. So let's observe API methods instead.
Is item declared as record
1
list := sp.Web().GetList("Lists/MyList")
2
item := list.Items().GetByID(1)
3
​
4
isRecord, err := item.Records().IsRecord()
5
if err != nil {
6
	log.Fatal(err)
7
}
8
​
9
fmt.Printf("Item is record? %t\n", isRecord)
Copied!
Is document declared as a record
Declaration as records is more common for documents (files), yet it's actually a file's item that keeps record status. And therefore holds API actions.
1
file := sp.Web().GetFile("MyLibrary/Contract.docx")
2
item, err := file.GetItem()
3
if err != nil {
4
	log.Fatal(err)
5
}
6
​
7
isRecord, err := item.Records().IsRecord()
8
if err != nil {
9
	log.Fatal(err)
10
}
11
​
12
fmt.Printf("Document is record? %t\n", isRecord)
Copied!
Declare as a record
1
	if err := item.Records().Declare(); err != nil {
2
		log.Fatal(err)
3
	}
Copied!
Undeclare as a record
1
if err := item.Records().Undeclare(); err != nil {
2
	log.Fatal(err)
3
}
Copied!
Declare with declaration date
The support of that method is not presented in old SharePoint versions.
1
date, _ := time.Parse(time.RFC3339, "2019-01-01T08:00:00.000Z")
2
if err := item.Records().DeclareWithDate(date); err != nil {
3
	log.Fatal(err)
4
}
Copied!
Summary
There is no methods for declaring and undeclaring items as records in SharePoint REST API (yet) and there won't be ever, IMO, for classic record management, but maybe to the modern, however, in Gosip, we mimic some CSOM calls and providing corresponding methods.

Samples - Previous

Attachments

Next - Samples

Sending Emails

Last modified 1yr ago

Export as PDF

Copy link

Contents

Is item declared as record

Is document declared as a record

Declare as a record

Undeclare as a record

Declare with declaration date

Summary