- Home [object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object]
- Manage types
- Global context and isolation
- Manage apps
- Batch actions with app items
- Manage external services
- Scripts in widgets
- Web components
- Access permissions
- Getting started with processes
- Getting started with signatures
- Getting started with file previews
- Getting started with the organizational chart
- Getting started with users and groups
-
Getting started with the
Table data type - Dynamic calculation of event type
- Use cases
-
API
- Object types
- Data types
- Global constants
- Work with apps
- Web requests
- Access permissions
- Document flow
- Live Chats
- “Code” widget
-
Signatures
- DigitalSignIdentificationType
- DigitalSignRequestStatus
- EntitySignOperationStatus
- SignStatus
- SignType
- SignTypes
- CertData
- CertNames
- DigitalSign
- DigitalSignActualizationData
- DigitalSignItemData
- DigitalSignProviderRef
- DigitalSignRequest
- DigitalSignSearch
- DigitalSigns
- EntitySign
- EntitySignItem
- EntitySignSearch
- EntitySigns
- EntityVersion
- NewSign
- SignData
- SignDetails
- SignProvider
- SignProviderItem
- SignProviderSearch
- SignProviders
- Signs
- SignHash
- SignedContent
- Business calendars
- Integration with IP telephony
- Integration with email marketing services
Service of working with app item signatures
The service allows searching for app item signatures as well as creating signature drafts to store data before issuing a signature.
Hierarchy
Methods
createDraft
Deprecated
Creates a draft of an app item signature.
The method creates a signature draft. It is used to store data before the signature is issued. To create a signature draft, pass the following parameters: — External ID of the signature obtained from the provider. It is used to get detailed information about the signature on the provider’s side. — Digital signature ID. — Reference object with a link to the item of an arbitrary app that needs to be signed. — Internal footprint of data that is being signed, for example, the file’s hash. —Signature type that determines what needs to be signed: the attributes, the file, or both.
Example:
const comment = 'some comment'; // The singing function in the external provider is called // The name `createSignInExternalProvider` is given as an example const issueId = await createSignInExternalProvider(); // ID of the digital signature that is used for signing // This ID is extracted from the context const digitalSignId = Context.data.digitalSignId; // A link to the app item that is being signed in extracted from the context // This can be done using search const item = Context.data.app; // Internal signatures of the app item const innerSign = await Context.data.app.getDataSigns(); // The app item’s update time extracted from its attributes const entityUpdateDate = Context.data.app.data .__updatedAt; // Signature type: attributes or file const t = Context.data. type; // Digital signature provider const provider = await System.providers .search().where(f => f.code.eq('<some code>')).first(); const entitySign = await System.signs.entitySigns.createDraft( issueId, digitalSignId, item, innerSign, entityUpdateDate, t, comment, provider, );
Use
createDraft
with the Signature update time parameter of theTDatetime
type or with the Digital signature provider object parameter of theSignProviderItem
type.Parameters
issueId: string
digitalSignId: string
item: RefItem
innerSign: SignData[]
entityUpdateDate: string
type: SignType
comment: string
provider: SignProvider
Returns Promise<EntitySignItem>
Object used to make search queries to search for app item signatures.
Creates a draft of an app item signature.
The method creates a signature draft. It is used to store data before the signature is issued. To create a signature draft, pass the following parameters: — External ID of the signature obtained from the provider. It is used to get detailed information about the signature on the provider’s side. — Digital signature ID. — Reference object with a link to the item of an arbitrary app that needs to be signed. — Internal footprint of data that is being signed, for example, the file’s hash. —Signature type that determines what needs to be signed: the attributes, the file, or both.
Example:
const comment = 'some comment'; // The singing function in the external provider is called // The name `createSignInExternalProvider` is given as an example const issueId = await createSignInExternalProvider(); // ID of the digital signature that is used for signing // This ID is extracted from the context const digitalSignId = Context.data.digitalSignId; // A link to the app item that is being signed in extracted from the context // This can be done using search const item = Context.data.app; // Internal signatures of the app item const innerSign = await Context.data.app.getDataSigns(); // The app item’s update time extracted from its attributes const entityUpdateDate = Context.data.app.data .__updatedAt; // Signature type: attributes or file const t = Context.data. type; // Digital signature provider const provider = await System.providers .search().where(f => f.code.eq('<some code>')).first(); const entitySign = await System.signs.entitySigns.createDraft( issueId, digitalSignId, item, innerSign, entityUpdateDate, t, comment, provider, );
Parameters
issueId: string
digitalSignId: string
item: RefItem
innerSign: SignData[]
entityUpdateDate: TDatetime
type: SignType
comment: string
provider: SignProviderItem
Returns Promise<EntitySignItem>
Object used to make search queries to search for app item signatures.
search
The method is used to search for signatures of an app item.
You can use this method to:
const entitySign = await System.signs.entitySigns.search().where(f => f.__id.eq( '<some id>')).first();
Returns EntitySignSearch
Object used to make search queries to search for signatures.
Methods