Export service

Which resources are chosen to be exported by the Export service varies depending upon the resource type that you want to export, and the attributes that you specify to match in selecting those resources.

Envelopes, code lists, and control numbers

To select envelopes, code lists, and control numbers for export, you can specify any of the following attribute combinations:

[name]
[name] [senderId]
[name] [receiverId]
[name] [senderId] [receiverId]

For envelopes, code lists, and control numbers, inclusion of the [name] attribute is assumed. For example, specifying senderId is the same as specifying both [name] and [receiverId].

Resources are selected differently for export, depending on the type of resource:

Table 1. Behavior of Export service in determining what envelopes, code lists, or control numbers to export
Resource type	Attribute being exported on	How resources to export are matched or filtered
Envelopes	`[name]` only	The `[name]` field acts as a "contains" filter. Case is ignored.
	`[name]` and `[senderId]`	Each of the `[name]` and `[senderId]` fields acts as a "contains" filter. Case is ignored.
	`[name]` and `[receiverId]`	Each of the `[name]` and `[receiver]` fields acts as a "contains" filters. Case is ignored.
	`[name]`, `[senderId]`, and `[receiverId]`	Each of the fields acts as a "contains" filter. Case is ignored.
Code lists	`[name]` only	The `[name]` field acts as a "contains" filter. Case is ignored.
	`[name]` and `[senderId]`	The `[name]` and `[senderId]` fields of a code list must exactly match the respective values that are input for those fields.
	`[name]` and `[receiverId]`	The `[name]` and `[receiverId]` fields of a code list must exactly match the respective values that are input for those fields.
	`[name]`, `[senderId]`, and `[receiverId]`	All three fields of the code list match the respective values that are input for those fields.
Control numbers	`[name]` only	The `[name]` field acts as a "contains" filter. Case is ignored.
	`[name]` and `[senderId]`	Behavior differs for each attribute: The `[name]` field acts as a "contains" filter. Case is ignored. The `[senderId]` for the control number must exactly match the value that is input for that field.
	`[name]` and `[receiverId]`	Behavior differs according to the attribute: The `[name]` field acts as a "contains" filter. Case is ignored. The `[receiverId]` for the control number must exactly match the value that is input for that field.
	`[name]`, `[senderId]`, and `[receiverId]`	Behavior differs according to the attribute: The `[name]` field acts as a "contains" filter. Case is ignored. The `[senderId]` and the `[receiverId]` for the control number must exactly match respective value that is input for those fields.

Maps and schemas

For maps and schemas, you can specify resources for export based on the [name] attribute only. The senderId and receiverId attributes do not apply and are ignored.

Resource type	How resources to export are matched or filtered
Maps	The `Name` field acts as a "container" filter. Case is ignored. The service exports all code lists with names that contain the value that is entered into the Name field of the UI.
Schemas	The `Name` field acts as a "container" filter. Case is ignored. Applies to all schema types. A schema must be active to be exported.

Other aspects of implementing the Export service are as described in the REST API overview.