Legal Service Policy Events 0.1.0 documentation

info

In this document, PUB means "publish" and SUB means "subscribe". This refers to the "publish/subscribe" (pub/sub) messaging framework, where "publish" means that the service sends data to Kafka topics, and "subscribe" means the service acts as a consumer that subscribes to specific Kafka topics to receive data.

• Specification ID: http://legal-service
• Protobuf File Spec: policy.proto

Table of Contents

• Operations
  • PUB basePolicy
  • PUB policy
  • PUB versionedPolicy
  • PUB localizedPolicy

Operations

PUB basePolicy Operation

Accepts one of the following messages:

Message basePolicyCreated

message is sent after base policy is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.basePolicy	object	-	-	-	additional properties are allowed
payload.basePolicy.id	string	base policy id	-	-	-
payload.basePolicy.basePolicyName	string	name of the base policy	-	-	-
payload.basePolicy.description	string	description of the base policy	-	-	-
payload.basePolicy.typeId	string	policy type id	-	-	-
payload.basePolicy.policyTypeName	string	policy type name, value can be Legal Document or Marketing Preference	-	-	-
payload.basePolicy.affectedClientIds	array<string>	affected oauth clients	-	-	-
payload.basePolicy.affectedClientIds (single item)	string	-	-	-	-
payload.basePolicy.affectedCountries	array<string>	countries included in the base policy	-	-	-
payload.basePolicy.affectedCountries (single item)	string	-	-	-	-
payload.basePolicy.createdAt	string	time when the base policy is created	-	format (date-time)	-
payload.basePolicy.updatedAt	string	time when the base policy is updated	-	format (date-time)	-
payload.basePolicy.isMandatory	boolean	a flag indicates whether this base policy is mandatory	-	-	-
payload.basePolicy.namespace	string	namespace of the base policy	-	-	-
payload.basePolicy.tags	array<string>	tags of this base policy	-	-	-
payload.basePolicy.tags (single item)	string	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema1"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "basePolicy": {
      "id": "string",
      "basePolicyName": "string",
      "description": "string",
      "typeId": "string",
      "policyTypeName": "string",
      "affectedClientIds": [
        "string"
      ],
      "affectedCountries": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "isMandatory": true,
      "namespace": "string",
      "tags": [
        "string"
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message basePolicyUpdated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.basePolicy	object	-	-	-	additional properties are allowed
payload.basePolicy.id	string	base policy id	-	-	-
payload.basePolicy.basePolicyName	string	name of the base policy	-	-	-
payload.basePolicy.description	string	description of the base policy	-	-	-
payload.basePolicy.typeId	string	policy type id	-	-	-
payload.basePolicy.policyTypeName	string	policy type name, value can be Legal Document or Marketing Preference	-	-	-
payload.basePolicy.affectedClientIds	array<string>	affected oauth clients	-	-	-
payload.basePolicy.affectedClientIds (single item)	string	-	-	-	-
payload.basePolicy.affectedCountries	array<string>	countries included in the base policy	-	-	-
payload.basePolicy.affectedCountries (single item)	string	-	-	-	-
payload.basePolicy.createdAt	string	time when the base policy is created	-	format (date-time)	-
payload.basePolicy.updatedAt	string	time when the base policy is updated	-	format (date-time)	-
payload.basePolicy.isMandatory	boolean	a flag indicates whether this base policy is mandatory	-	-	-
payload.basePolicy.namespace	string	namespace of the base policy	-	-	-
payload.basePolicy.tags	array<string>	tags of this base policy	-	-	-
payload.basePolicy.tags (single item)	string	-	-	-	-
payload.x-uid0	-	-	"AnonymousSchema2"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "basePolicy": {
      "id": "string",
      "basePolicyName": "string",
      "description": "string",
      "typeId": "string",
      "policyTypeName": "string",
      "affectedClientIds": [
        "string"
      ],
      "affectedCountries": [
        "string"
      ],
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "isMandatory": true,
      "namespace": "string",
      "tags": [
        "string"
      ]
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

PUB policy Operation

Accepts one of the following messages:

Message policyCreated

message is sent when country based policy is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.policy	object	-	-	-	additional properties are allowed
payload.policy.id	string	policy id	-	-	-
payload.policy.policyName	string	policy name	-	-	-
payload.policy.countryCode	string	country code	-	-	-
payload.policy.createdAt	string	time when the policy is created	-	format (date-time)	-
payload.policy.updatedAt	string	time when the policy is updated	-	format (date-time)	-
payload.policy.shouldNotifyOnUpdate	boolean	a flag indicates whether need to notify users if this policy is updated	-	-	-
payload.policy.countryGroupCode	string	-	-	-	deprecated
payload.policy.isMandatory	boolean	a flag indicates whether this policy is mandatory	-	-	-
payload.policy.isDefaultOpted	boolean	-	-	-	deprecated
payload.policy.basePolicyId	string	-	-	-	deprecated
payload.policy.readableId	string	-	-	-	deprecated
payload.policy.description	string	description of this policy	-	-	-
payload.policy.isDefaultSelection	boolean	a flag indicates whether this country based policy is the default selected	-	-	-
payload.x-uid0	-	-	"AnonymousSchema3"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "policy": {
      "id": "string",
      "policyName": "string",
      "countryCode": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "shouldNotifyOnUpdate": true,
      "countryGroupCode": "string",
      "isMandatory": true,
      "isDefaultOpted": true,
      "basePolicyId": "string",
      "readableId": "string",
      "description": "string",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message policyUpdated

message is sent when country base policy is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.policy	object	-	-	-	additional properties are allowed
payload.policy.id	string	policy id	-	-	-
payload.policy.policyName	string	policy name	-	-	-
payload.policy.countryCode	string	country code	-	-	-
payload.policy.createdAt	string	time when the policy is created	-	format (date-time)	-
payload.policy.updatedAt	string	time when the policy is updated	-	format (date-time)	-
payload.policy.shouldNotifyOnUpdate	boolean	a flag indicates whether need to notify users if this policy is updated	-	-	-
payload.policy.countryGroupCode	string	-	-	-	deprecated
payload.policy.isMandatory	boolean	a flag indicates whether this policy is mandatory	-	-	-
payload.policy.isDefaultOpted	boolean	-	-	-	deprecated
payload.policy.basePolicyId	string	-	-	-	deprecated
payload.policy.readableId	string	-	-	-	deprecated
payload.policy.description	string	description of this policy	-	-	-
payload.policy.isDefaultSelection	boolean	a flag indicates whether this country based policy is the default selected	-	-	-
payload.x-uid0	-	-	"AnonymousSchema4"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "policy": {
      "id": "string",
      "policyName": "string",
      "countryCode": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "shouldNotifyOnUpdate": true,
      "countryGroupCode": "string",
      "isMandatory": true,
      "isDefaultOpted": true,
      "basePolicyId": "string",
      "readableId": "string",
      "description": "string",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message defaultPolicyUpdated

message is sent when country based policy is set to default

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.policy	object	-	-	-	additional properties are allowed
payload.policy.id	string	policy id	-	-	-
payload.policy.policyName	string	policy name	-	-	-
payload.policy.countryCode	string	country code	-	-	-
payload.policy.createdAt	string	time when the policy is created	-	format (date-time)	-
payload.policy.updatedAt	string	time when the policy is updated	-	format (date-time)	-
payload.policy.shouldNotifyOnUpdate	boolean	a flag indicates whether need to notify users if this policy is updated	-	-	-
payload.policy.countryGroupCode	string	-	-	-	deprecated
payload.policy.isMandatory	boolean	a flag indicates whether this policy is mandatory	-	-	-
payload.policy.isDefaultOpted	boolean	-	-	-	deprecated
payload.policy.basePolicyId	string	-	-	-	deprecated
payload.policy.readableId	string	-	-	-	deprecated
payload.policy.description	string	description of this policy	-	-	-
payload.policy.isDefaultSelection	boolean	a flag indicates whether this country based policy is the default selected	-	-	-
payload.x-uid0	-	-	"AnonymousSchema5"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "policy": {
      "id": "string",
      "policyName": "string",
      "countryCode": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "shouldNotifyOnUpdate": true,
      "countryGroupCode": "string",
      "isMandatory": true,
      "isDefaultOpted": true,
      "basePolicyId": "string",
      "readableId": "string",
      "description": "string",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

PUB versionedPolicy Operation

Accepts one of the following messages:

Message versionedPolicyCreated

message is sent when policy version is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.versionedPolicy	object	-	-	-	additional properties are allowed
payload.versionedPolicy.id	string	policy version id	-	-	-
payload.versionedPolicy.policyId	string	policy id this policy version belongs to	-	-	-
payload.versionedPolicy.displayVersion	string	display version of this policy version	-	-	-
payload.versionedPolicy.description	string	description of this policy version	-	-	-
payload.versionedPolicy.status	string	status of this policy version, values can be empty string if never published or PUBLISHED/ACTIVE	-	-	-
payload.versionedPolicy.createdAt	string	time when this version is created	-	format (date-time)	-
payload.versionedPolicy.updatedAt	string	time when this version is updated	-	format (date-time)	-
payload.versionedPolicy.publishedDate	string	time when this version is published	-	format (date-time)	-
payload.versionedPolicy.isCrucial	boolean	-	-	-	deprecated
payload.versionedPolicy.isCommitted	boolean	-	-	-	deprecated
payload.versionedPolicy.isInEffect	boolean	a flag indicates whether this version is currently published	-	-	-
payload.x-uid0	-	-	"AnonymousSchema6"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "versionedPolicy": {
      "id": "string",
      "policyId": "string",
      "displayVersion": "string",
      "description": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isCrucial": true,
      "isCommitted": true,
      "isInEffect": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message versionedPolicyUpdated

message is sent when policy version is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.versionedPolicy	object	-	-	-	additional properties are allowed
payload.versionedPolicy.id	string	policy version id	-	-	-
payload.versionedPolicy.policyId	string	policy id this policy version belongs to	-	-	-
payload.versionedPolicy.displayVersion	string	display version of this policy version	-	-	-
payload.versionedPolicy.description	string	description of this policy version	-	-	-
payload.versionedPolicy.status	string	status of this policy version, values can be empty string if never published or PUBLISHED/ACTIVE	-	-	-
payload.versionedPolicy.createdAt	string	time when this version is created	-	format (date-time)	-
payload.versionedPolicy.updatedAt	string	time when this version is updated	-	format (date-time)	-
payload.versionedPolicy.publishedDate	string	time when this version is published	-	format (date-time)	-
payload.versionedPolicy.isCrucial	boolean	-	-	-	deprecated
payload.versionedPolicy.isCommitted	boolean	-	-	-	deprecated
payload.versionedPolicy.isInEffect	boolean	a flag indicates whether this version is currently published	-	-	-
payload.x-uid0	-	-	"AnonymousSchema7"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "versionedPolicy": {
      "id": "string",
      "policyId": "string",
      "displayVersion": "string",
      "description": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isCrucial": true,
      "isCommitted": true,
      "isInEffect": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message versionedPolicyPublished

message is sent when policy version is published

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.versionedPolicy	object	-	-	-	additional properties are allowed
payload.versionedPolicy.id	string	policy version id	-	-	-
payload.versionedPolicy.policyId	string	policy id this policy version belongs to	-	-	-
payload.versionedPolicy.displayVersion	string	display version of this policy version	-	-	-
payload.versionedPolicy.description	string	description of this policy version	-	-	-
payload.versionedPolicy.status	string	status of this policy version, values can be empty string if never published or PUBLISHED/ACTIVE	-	-	-
payload.versionedPolicy.createdAt	string	time when this version is created	-	format (date-time)	-
payload.versionedPolicy.updatedAt	string	time when this version is updated	-	format (date-time)	-
payload.versionedPolicy.publishedDate	string	time when this version is published	-	format (date-time)	-
payload.versionedPolicy.isCrucial	boolean	-	-	-	deprecated
payload.versionedPolicy.isCommitted	boolean	-	-	-	deprecated
payload.versionedPolicy.isInEffect	boolean	a flag indicates whether this version is currently published	-	-	-
payload.x-uid0	-	-	"AnonymousSchema8"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "versionedPolicy": {
      "id": "string",
      "policyId": "string",
      "displayVersion": "string",
      "description": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isCrucial": true,
      "isCommitted": true,
      "isInEffect": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

PUB localizedPolicy Operation

Accepts one of the following messages:

Message localizedPolicyCreated

message is sent when localized policy is created

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.localizedPolicy	object	-	-	-	additional properties are allowed
payload.localizedPolicy.id	string	localized policy version id	-	-	-
payload.localizedPolicy.versionedPolicyId	string	policy version id	-	-	-
payload.localizedPolicy.description	string	description of localized policy version	-	-	-
payload.localizedPolicy.localeCode	string	locale/language code	-	-	-
payload.localizedPolicy.contentType	string	type of the source file, text/html or text/markdown	-	-	-
payload.localizedPolicy.attachmentLocation	string	location of the source file in the storage	-	-	-
payload.localizedPolicy.attachmentChecksum	string	checksum of the source file	-	-	-
payload.localizedPolicy.attachmentVersionIdentifier	string	identifier of the source file	-	-	-
payload.localizedPolicy.status	string	-	-	-	deprecated
payload.localizedPolicy.createdAt	string	time when this localized version was created	-	format (date-time)	-
payload.localizedPolicy.updatedAt	string	time when this localized version was updated	-	format (date-time)	-
payload.localizedPolicy.publishedDate	string	-	-	format (date-time)	deprecated
payload.localizedPolicy.isDefaultSelection	boolean	-	-	-	deprecated
payload.x-uid0	-	-	"AnonymousSchema9"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "localizedPolicy": {
      "id": "string",
      "versionedPolicyId": "string",
      "description": "string",
      "localeCode": "string",
      "contentType": "string",
      "attachmentLocation": "string",
      "attachmentChecksum": "string",
      "attachmentVersionIdentifier": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message localizedPolicyUpdated

message is sent when localized policy is updated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.localizedPolicy	object	-	-	-	additional properties are allowed
payload.localizedPolicy.id	string	localized policy version id	-	-	-
payload.localizedPolicy.versionedPolicyId	string	policy version id	-	-	-
payload.localizedPolicy.description	string	description of localized policy version	-	-	-
payload.localizedPolicy.localeCode	string	locale/language code	-	-	-
payload.localizedPolicy.contentType	string	type of the source file, text/html or text/markdown	-	-	-
payload.localizedPolicy.attachmentLocation	string	location of the source file in the storage	-	-	-
payload.localizedPolicy.attachmentChecksum	string	checksum of the source file	-	-	-
payload.localizedPolicy.attachmentVersionIdentifier	string	identifier of the source file	-	-	-
payload.localizedPolicy.status	string	-	-	-	deprecated
payload.localizedPolicy.createdAt	string	time when this localized version was created	-	format (date-time)	-
payload.localizedPolicy.updatedAt	string	time when this localized version was updated	-	format (date-time)	-
payload.localizedPolicy.publishedDate	string	-	-	format (date-time)	deprecated
payload.localizedPolicy.isDefaultSelection	boolean	-	-	-	deprecated
payload.x-uid0	-	-	"AnonymousSchema10"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "localizedPolicy": {
      "id": "string",
      "versionedPolicyId": "string",
      "description": "string",
      "localeCode": "string",
      "contentType": "string",
      "attachmentLocation": "string",
      "attachmentChecksum": "string",
      "attachmentVersionIdentifier": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}

Message defaultLocalizedPolicyUpdated

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object allOf	-	-	-	additional properties are allowed
payload	object	-	-	-	additional properties are allowed
payload.localizedPolicy	object	-	-	-	additional properties are allowed
payload.localizedPolicy.id	string	localized policy version id	-	-	-
payload.localizedPolicy.versionedPolicyId	string	policy version id	-	-	-
payload.localizedPolicy.description	string	description of localized policy version	-	-	-
payload.localizedPolicy.localeCode	string	locale/language code	-	-	-
payload.localizedPolicy.contentType	string	type of the source file, text/html or text/markdown	-	-	-
payload.localizedPolicy.attachmentLocation	string	location of the source file in the storage	-	-	-
payload.localizedPolicy.attachmentChecksum	string	checksum of the source file	-	-	-
payload.localizedPolicy.attachmentVersionIdentifier	string	identifier of the source file	-	-	-
payload.localizedPolicy.status	string	-	-	-	deprecated
payload.localizedPolicy.createdAt	string	time when this localized version was created	-	format (date-time)	-
payload.localizedPolicy.updatedAt	string	time when this localized version was updated	-	format (date-time)	-
payload.localizedPolicy.publishedDate	string	-	-	format (date-time)	deprecated
payload.localizedPolicy.isDefaultSelection	boolean	-	-	-	deprecated
payload.x-uid0	-	-	"AnonymousSchema11"	-	-
0 (allOf item)	object	-	-	-	additional properties are allowed
id	string	-	-	-	-
version	integer	-	-	-	-
name	string	-	-	-	-
namespace	string	-	-	-	-
parentNamespace	string	-	-	-	-
timestamp	string	-	-	format (date-time)	-
clientId	string	-	-	-	-
userId	string	-	-	-	-
traceId	string	-	-	-	-
sessionId	string	-	-	-	-

Examples of payload (generated)

{
  "payload": {
    "localizedPolicy": {
      "id": "string",
      "versionedPolicyId": "string",
      "description": "string",
      "localeCode": "string",
      "contentType": "string",
      "attachmentLocation": "string",
      "attachmentChecksum": "string",
      "attachmentVersionIdentifier": "string",
      "status": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "publishedDate": "2019-08-24T14:15:22Z",
      "isDefaultSelection": true
    }
  },
  "id": "string",
  "version": 0,
  "name": "string",
  "namespace": "string",
  "parentNamespace": "string",
  "timestamp": "2019-08-24T14:15:22Z",
  "clientId": "string",
  "userId": "string",
  "traceId": "string",
  "sessionId": "string"
}