Jump to

• Request
• Response

Create a communication resource

post

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCommunicationResources-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the communication resource.
• CommResourceRelations(optional): array Communication Related Resources
  Title: Communication Related Resources

  The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the communication resource.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the communication resource was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 256

  The description for the communication resource.
• EmEnabled(optional): string
  Maximum Length: 1

  Indicates whether the resource is enabled for use in the business rules framework. The default value is N.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the communication resource is available to be used. The default value is false.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the communication resource was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the communication resource.
• links(optional): array Items
  Title: Items

  Link Relations
• ModuleId(optional): string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• OfferingId(optional): string
  Maximum Length: 80

  The offering under which this resource is categorized.
• ResourceCode(optional): string
  Title: Resource Code

  Maximum Length: 32

  The unique code for the communication resource.
• ResourceId(optional): integer(int64)
  Title: Resource ID

  The unique identifier of the communication resource. This ID is automatically generated by the application.
• ResourceName(optional): string
  Title: Resource Name

  Maximum Length: 100

  The name of the communication resource.
• ResourcePath(optional): string
  Title: Resource Endpoint

  Maximum Length: 1000

  The communication resource REST endpoint name.
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication resource.",
            "title":"Agency ID"
        },
        "CommResourceRelations":{
            "items":{
                "$ref":"#/definitions/publicSectorCommunicationResources-CommResourceRelations-item"
            },
            "type":"array",
            "description":"The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.",
            "title":"Communication Related Resources"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication resource.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the communication resource was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "Description":{
            "maxLength":256,
            "type":"string",
            "description":"The description for the communication resource.",
            "title":"Description"
        },
        "EmEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the resource is enabled for use in the business rules framework. The default value is N."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the communication resource is available to be used. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the communication resource was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication resource.",
            "title":"Last Updated By"
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data."
        },
        "OfferingId":{
            "maxLength":80,
            "type":"string",
            "description":"The offering under which this resource is categorized."
        },
        "ResourceCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique code for the communication resource.",
            "title":"Resource Code"
        },
        "ResourceId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the communication resource. This ID is automatically generated by the application.",
            "title":"Resource ID"
        },
        "ResourceName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the communication resource.",
            "title":"Resource Name"
        },
        "ResourcePath":{
            "maxLength":1000,
            "type":"string",
            "description":"The communication resource REST endpoint name.",
            "title":"Resource Endpoint"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Communication Related Resources

Type: array

Title: Communication Related Resources

The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.

Show Source

• Array of: object publicSectorCommunicationResources-CommResourceRelations-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCommunicationResources-CommResourceRelations-item"
    },
    "type":"array",
    "description":"The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.",
    "title":"Communication Related Resources"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCommunicationResources-CommResourceRelations-item

Type: object

Show Source

• AnchorFifthKeyName(optional): string
  Maximum Length: 100

  The fifth key name of the anchor communication resource.
• AnchorFirstKeyName(optional): string
  Maximum Length: 100

  The first key name of the anchor communication resource.
• AnchorFourthKeyName(optional): string
  Maximum Length: 100

  The fourth key name of the anchor communication resource.
• AnchorResourceCode(optional): string
  Title: Resource Code

  Maximum Length: 32

  The anchor resource code.
• AnchorResourceId(optional): integer(int64)
  The anchor resource identifier.
• AnchorSecondKeyName(optional): string
  Maximum Length: 100

  The second key name of the anchor communication resource.
• AnchorThirdKeyName(optional): string
  Maximum Length: 100

  The third key name of the anchor communication resource.
• ContactTypeResFlag(optional): string
  Maximum Length: 1

  Indicates whether the resource relation is based on the contact type. If the value is Y, the resource relation is contact type based. The default value is N.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• links(optional): array Items
  Title: Items

  Link Relations
• ModuleId(optional): string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• RelatedFifthKeyName(optional): string
  Maximum Length: 100

  The fifth key name of the related communication resource.
• RelatedFirstKeyName(optional): string
  Maximum Length: 100

  The first key name of the related communication resource.
• RelatedFourthKeyName(optional): string
  Maximum Length: 100

  The fourth key name of the related communication resource.
• RelatedResourceCode(optional): string
  Title: Resource Code

  Maximum Length: 32

  The related resource code.
• RelatedResourceId(optional): integer(int64)
  The related resource identifier.
• RelatedSecondKeyName(optional): string
  Maximum Length: 100

  The second key name of the related communication resource.
• RelatedThirdKeyName(optional): string
  Maximum Length: 100

  The third key name of the related communication resource.
• ResourceRelationCode(optional): string
  Maximum Length: 100

  The unique code for the related communication resource.
• ResourceRelationId(optional): integer(int64)
  The unique identifier for the related communication resource. This is automatically generated by the application.
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• SeedDataSource(optional): string
  Maximum Length: 512

  Indicates the source of the seed data.

{
    "properties":{
        "AnchorFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the anchor communication resource."
        },
        "AnchorFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the anchor communication resource."
        },
        "AnchorFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the anchor communication resource."
        },
        "AnchorResourceCode":{
            "maxLength":32,
            "type":"string",
            "description":"The anchor resource code.",
            "title":"Resource Code"
        },
        "AnchorResourceId":{
            "format":"int64",
            "type":"integer",
            "description":"The anchor resource identifier."
        },
        "AnchorSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the anchor communication resource."
        },
        "AnchorThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the anchor communication resource."
        },
        "ContactTypeResFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the resource relation is based on the contact type. If the value is Y, the resource relation is contact type based. The default value is N."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data."
        },
        "RelatedFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the related communication resource."
        },
        "RelatedFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the related communication resource."
        },
        "RelatedFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the related communication resource."
        },
        "RelatedResourceCode":{
            "maxLength":32,
            "type":"string",
            "description":"The related resource code.",
            "title":"Resource Code"
        },
        "RelatedResourceId":{
            "format":"int64",
            "type":"integer",
            "description":"The related resource identifier."
        },
        "RelatedSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the related communication resource."
        },
        "RelatedThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the related communication resource."
        },
        "ResourceRelationCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique code for the related communication resource."
        },
        "ResourceRelationId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the related communication resource. This is automatically generated by the application."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated."
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"Indicates the source of the seed data."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCommunicationResources-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with the communication resource.
• CommResourceRelations(optional): array Communication Related Resources
  Title: Communication Related Resources

  The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the communication resource.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time that the communication resource was created.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• Description(optional): string
  Title: Description

  Maximum Length: 256

  The description for the communication resource.
• EmEnabled(optional): string
  Maximum Length: 1

  Indicates whether the resource is enabled for use in the business rules framework. The default value is N.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates whether the communication resource is available to be used. The default value is false.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date that the communication resource was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the communication resource.
• links(optional): array Items
  Title: Items

  Link Relations
• ModuleId(optional): string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• OfferingId(optional): string
  Maximum Length: 80

  The offering under which this resource is categorized.
• ResourceCode(optional): string
  Title: Resource Code

  Maximum Length: 32

  The unique code for the communication resource.
• ResourceId(optional): integer(int64)
  Title: Resource ID

  The unique identifier of the communication resource. This ID is automatically generated by the application.
• ResourceName(optional): string
  Title: Resource Name

  Maximum Length: 100

  The name of the communication resource.
• ResourcePath(optional): string
  Title: Resource Endpoint

  Maximum Length: 1000

  The communication resource REST endpoint name.
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the communication resource.",
            "title":"Agency ID"
        },
        "CommResourceRelations":{
            "items":{
                "$ref":"#/definitions/publicSectorCommunicationResources-CommResourceRelations-item"
            },
            "type":"array",
            "description":"The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.",
            "title":"Communication Related Resources"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the communication resource.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time that the communication resource was created.",
            "title":"Creation Date"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "Description":{
            "maxLength":256,
            "type":"string",
            "description":"The description for the communication resource.",
            "title":"Description"
        },
        "EmEnabled":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the resource is enabled for use in the business rules framework. The default value is N."
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the communication resource is available to be used. The default value is false.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date that the communication resource was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication resource.",
            "title":"Last Updated By"
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data."
        },
        "OfferingId":{
            "maxLength":80,
            "type":"string",
            "description":"The offering under which this resource is categorized."
        },
        "ResourceCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique code for the communication resource.",
            "title":"Resource Code"
        },
        "ResourceId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the communication resource. This ID is automatically generated by the application.",
            "title":"Resource ID"
        },
        "ResourceName":{
            "maxLength":100,
            "type":"string",
            "description":"The name of the communication resource.",
            "title":"Resource Name"
        },
        "ResourcePath":{
            "maxLength":1000,
            "type":"string",
            "description":"The communication resource REST endpoint name.",
            "title":"Resource Endpoint"
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Communication Related Resources

Type: array

Title: Communication Related Resources

The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.

Show Source

• Array of: object publicSectorCommunicationResources-CommResourceRelations-item

{
    "items":{
        "$ref":"#/definitions/publicSectorCommunicationResources-CommResourceRelations-item"
    },
    "type":"array",
    "description":"The communications related resources resource is used to view the established relationship between an anchor resource and a related resource.",
    "title":"Communication Related Resources"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorCommunicationResources-CommResourceRelations-item

Type: object

Show Source

• AnchorFifthKeyName(optional): string
  Maximum Length: 100

  The fifth key name of the anchor communication resource.
• AnchorFirstKeyName(optional): string
  Maximum Length: 100

  The first key name of the anchor communication resource.
• AnchorFourthKeyName(optional): string
  Maximum Length: 100

  The fourth key name of the anchor communication resource.
• AnchorResourceCode(optional): string
  Title: Resource Code

  Maximum Length: 32

  The anchor resource code.
• AnchorResourceId(optional): integer(int64)
  The anchor resource identifier.
• AnchorSecondKeyName(optional): string
  Maximum Length: 100

  The second key name of the anchor communication resource.
• AnchorThirdKeyName(optional): string
  Maximum Length: 100

  The third key name of the anchor communication resource.
• ContactTypeResFlag(optional): string
  Maximum Length: 1

  Indicates whether the resource relation is based on the contact type. If the value is Y, the resource relation is contact type based. The default value is N.
• DeletedFlag(optional): string
  Maximum Length: 1

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• links(optional): array Items
  Title: Items

  Link Relations
• ModuleId(optional): string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• RelatedFifthKeyName(optional): string
  Maximum Length: 100

  The fifth key name of the related communication resource.
• RelatedFirstKeyName(optional): string
  Maximum Length: 100

  The first key name of the related communication resource.
• RelatedFourthKeyName(optional): string
  Maximum Length: 100

  The fourth key name of the related communication resource.
• RelatedResourceCode(optional): string
  Title: Resource Code

  Maximum Length: 32

  The related resource code.
• RelatedResourceId(optional): integer(int64)
  The related resource identifier.
• RelatedSecondKeyName(optional): string
  Maximum Length: 100

  The second key name of the related communication resource.
• RelatedThirdKeyName(optional): string
  Maximum Length: 100

  The third key name of the related communication resource.
• ResourceRelationCode(optional): string
  Maximum Length: 100

  The unique code for the related communication resource.
• ResourceRelationId(optional): integer(int64)
  The unique identifier for the related communication resource. This is automatically generated by the application.
• SeedDataLock(optional): integer(int32)
  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
• SeedDataSource(optional): string
  Maximum Length: 512

  Indicates the source of the seed data.

{
    "properties":{
        "AnchorFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the anchor communication resource."
        },
        "AnchorFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the anchor communication resource."
        },
        "AnchorFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the anchor communication resource."
        },
        "AnchorResourceCode":{
            "maxLength":32,
            "type":"string",
            "description":"The anchor resource code.",
            "title":"Resource Code"
        },
        "AnchorResourceId":{
            "format":"int64",
            "type":"integer",
            "description":"The anchor resource identifier."
        },
        "AnchorSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the anchor communication resource."
        },
        "AnchorThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the anchor communication resource."
        },
        "ContactTypeResFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the resource relation is based on the contact type. If the value is Y, the resource relation is contact type based. The default value is N."
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N."
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data."
        },
        "RelatedFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the related communication resource."
        },
        "RelatedFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the related communication resource."
        },
        "RelatedFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the related communication resource."
        },
        "RelatedResourceCode":{
            "maxLength":32,
            "type":"string",
            "description":"The related resource code.",
            "title":"Resource Code"
        },
        "RelatedResourceId":{
            "format":"int64",
            "type":"integer",
            "description":"The related resource identifier."
        },
        "RelatedSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the related communication resource."
        },
        "RelatedThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the related communication resource."
        },
        "ResourceRelationCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique code for the related communication resource."
        },
        "ResourceRelationId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for the related communication resource. This is automatically generated by the application."
        },
        "SeedDataLock":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated."
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"Indicates the source of the seed data."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top