AgreementRef

Extends: EntityRef

Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.

Field Required Nullable Type Description Constraints Example

Field	Required	Nullable	Type	Description	Constraints	Example
`@type`	Yes	No	`String`	When sub-classing, this defines the sub-class Extensible name	default `null`;
`@baseType`	No	No	`String`	When sub-classing, this defines the super-class	default `null`;
`@schemaLocation`	No	No	`String`	A URI to a JSON-Schema file that defines additional attributes and relationships	default `null`;
`id`	Yes	No	`String`	Identifier of the referred entity.	default `null`;	2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
`href`	No	No	`URI`	Hyperlink reference	default `null`;	https://api.example.org/resource/id
`name`	No	No	`String`	Name of the referred entity.	default `null`;	EntityName
`@referredType`	No	No	`String`	The actual type of the target instance when needed for disambiguation.	default `null`;

@type

Yes

String

When sub-classing, this defines the sub-class Extensible name

default null;

@baseType

String

When sub-classing, this defines the super-class

default null;

@schemaLocation

String

A URI to a JSON-Schema file that defines additional attributes and relationships

default null;

id

Yes

String

Identifier of the referred entity.

default null;

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

URI

Hyperlink reference

default null;

https://api.example.org/resource/id

name

String

Name of the referred entity.

default null;

EntityName

@referredType

String

The actual type of the target instance when needed for disambiguation.

default null;