Skip to content

Campaign Parameters

Description

Parameters which define a Campaign within a Brand in the system.

Campaign ParametersCampaign Parameters Document    Relationshipscluster_system_parametersSystem ParametersBrand Parameters                             Brand Parameters                        Campaign Parameters                             Campaign Parameters                        content typeapplication/jsontype5ef32d5d-f240-462c-a7a4-ba4af221fa23idDocument IdverDocument VerparametersBrand ParametersCampaign Parameters:e->Brand Parameters:w1*Category Parameters                             Category Parameters                        Category Parameters:e->Campaign Parameters:w1*Decision Parameters                         Decision Parameters                    Decision Parameters:e->Campaign Parameters1*Proposal                         Proposal                    Proposal:e->Campaign Parameters1*Proposal Comment                         Proposal Comment                    Proposal Comment:e->Campaign Parameters1*Proposal Comment Meta Template                         Proposal Comment Meta Template                    Proposal Comment Meta Template:e->Campaign Parameters1*Proposal Comment Template                         Proposal Comment Template                    Proposal Comment Template:e->Campaign Parameters1*Proposal Meta Template                         Proposal Meta Template                    Proposal Meta Template:e->Campaign Parameters1*Proposal Submission Action                         Proposal Submission Action                    Proposal Submission Action:e->Campaign Parameters1*Proposal Template                         Proposal Template                    Proposal Template:e->Campaign Parameters1*

Validation

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

Business Logic

Front End

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

Back End

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

COSE Header Parameters

Metadata

type

Parameter Value
Required yes
Format Document Type
Type 5ef32d5d-f240-462c-a7a4-ba4af221fa23

The document TYPE.

type Validation

MUST be a known document type.

id

Parameter Value
Required yes
Format Document Id

Document ID, created the first time the document is created. This must be a properly created UUIDv7 which contains the timestamp of when the document was created.

id Validation

IF ver does not == id then a document with id and ver being equal MUST exist.

ver

Parameter Value
Required yes
Format Document Ver

The unique version of the document. The first version of the document must set ver == id

ver Validation

The document version must always be >= the document ID.

parameters

Parameter Value
Required yes
Format Document Reference
Valid References Brand Parameters

A reference to the Parameters Document this document lies under.

parameters Validation

In addition to the validation performed for Document Reference type fields:

  • Any linked referenced document that includes a parameters metadata must match the parameters of the referencing document.

Payload

This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.

Signers

The following user roles may sign documents of this type:

  • Registered

New versions of this document may be published by:

  • author
Copyright © 2024-2025 IOG Singapore, All Rights Reserved
License This document is licensed under CC-BY-4.0
Created 2024-12-27
Modified 2025-05-05
Authors Alex Pozhylenkov alex.pozhylenkov@iohk.io
Steven Johnson steven.johnson@iohk.io

Changelog

0.01 (2025-04-04)

  • First Published Version

0.03 (2025-05-05)

  • Use generalized parameters.