Create unplaced element
Creates one or more unplaced elements on the specified package. The request body is an array; each entry creates one unplaced element.
An unplaced element is created on the package without a position on a document. It can later be positioned with the Package Elements Editor (see Get elements action url) or by creating a placed element that references it.
Four element types can be created, selected by the Type field on each entry:
signing fields, check box fields, text box fields and radio groups. Because unplaced
elements carry no position, only the type-specific content (signing methods, legal
notice, form-field name/label, radio options, and so on) is supplied - never a
location, dimensions, marker or field identifier.
Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The target package's unique identifier A package's unique identifier
"00000000-0000-0000-0000-000000000000"
Body
Collection of unplaced elements to be added to the package.
- Unplaced signing field
- Unplaced check box
- Unplaced text box
- Unplaced radio group
A field that can be signed by an actor
the type of element ( the discriminator of the different types of elements, for the moment there's just one! )
SigningField The signing methods that may be used to sign this signing field. Supply at least one; always as an array.
1An NSEV signing method
External reference to this resource set by the calling application. NSEV does not use this value itself. When filtering packages, this matches the package-level external reference only, not document or field references.
256An optional legal notice added to the signing field. Supply either a custom Text
or the Name of a notice configured in the Config Index.
- Custom legal notice text
- Named legal notice from Config Index
Response
Ok
- Unplaced signing field (result)
- Unplaced check box field (result)
- Unplaced text box field (result)
- Unplaced radio group (result)
A field that can be signed by an actor
the type of element ( the discriminator of the different types of elements, for the moment there's just one! )
SigningField An element's unique identifier
"00000000-0000-0000-0000-000000000000"
This actor's unique identifier
"00000000-0000-0000-0000-000000000000"
The status of a document element
Pending, InProgress, Rejected, Failed, Finished, Refused External reference to this resource set by the calling application. NSEV does not use this value itself. When filtering packages, this matches the package-level external reference only, not document or field references.
256the type of marker (if set)
None, Text, PdfFormField A piece of text or PDF field identifier
An NSEV signing method