Jump to

• Request
• Response

Update a related communication resource

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCommunicationResources/{ResourceId}/child/CommResourceRelations/{ResourceRelationId}

Request

Supported Media Types

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

Path Parameters

• ResourceId: integer
  The unique identifier of the communication resource. This ID is automatically generated by the application.
• ResourceRelationId: integer
  The unique identifier for the related communication resource. This is automatically generated by the application.

Body ()

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

Root 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
  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
  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.

{
    "type":"object",
    "properties":{
        "AnchorFifthKeyName":{
            "description":"The fifth key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "AnchorFirstKeyName":{
            "description":"The first key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "AnchorFourthKeyName":{
            "description":"The fourth key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "AnchorResourceCode":{
            "description":"The anchor resource code.",
            "type":"string",
            "maxLength":32
        },
        "AnchorResourceId":{
            "description":"The anchor resource identifier.",
            "type":"integer",
            "format":"int64"
        },
        "AnchorSecondKeyName":{
            "description":"The second key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "AnchorThirdKeyName":{
            "description":"The third key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "ContactTypeResFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "RelatedFifthKeyName":{
            "description":"The fifth key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "RelatedFirstKeyName":{
            "description":"The first key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "RelatedFourthKeyName":{
            "description":"The fourth key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "RelatedResourceCode":{
            "description":"The related resource code.",
            "type":"string",
            "maxLength":32
        },
        "RelatedResourceId":{
            "description":"The related resource identifier.",
            "type":"integer",
            "format":"int64"
        },
        "RelatedSecondKeyName":{
            "description":"The second key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "RelatedThirdKeyName":{
            "description":"The third key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "ResourceRelationCode":{
            "description":"The unique code for the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "ResourceRelationId":{
            "description":"The unique identifier for the related communication resource. This is automatically generated by the application.",
            "type":"integer",
            "format":"int64"
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "description":"Indicates the source of the seed data.",
            "type":"string",
            "maxLength":512
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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-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
  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
  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.

{
    "type":"object",
    "properties":{
        "AnchorFifthKeyName":{
            "description":"The fifth key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "AnchorFirstKeyName":{
            "description":"The first key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "AnchorFourthKeyName":{
            "description":"The fourth key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "AnchorResourceCode":{
            "description":"The anchor resource code.",
            "type":"string",
            "maxLength":32
        },
        "AnchorResourceId":{
            "description":"The anchor resource identifier.",
            "type":"integer",
            "format":"int64"
        },
        "AnchorSecondKeyName":{
            "description":"The second key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "AnchorThirdKeyName":{
            "description":"The third key name of the anchor communication resource.",
            "type":"string",
            "maxLength":100
        },
        "ContactTypeResFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "DeletedFlag":{
            "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.",
            "type":"string",
            "maxLength":1
        },
        "ModuleId":{
            "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.",
            "type":"string",
            "maxLength":32
        },
        "RelatedFifthKeyName":{
            "description":"The fifth key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "RelatedFirstKeyName":{
            "description":"The first key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "RelatedFourthKeyName":{
            "description":"The fourth key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "RelatedResourceCode":{
            "description":"The related resource code.",
            "type":"string",
            "maxLength":32
        },
        "RelatedResourceId":{
            "description":"The related resource identifier.",
            "type":"integer",
            "format":"int64"
        },
        "RelatedSecondKeyName":{
            "description":"The second key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "RelatedThirdKeyName":{
            "description":"The third key name of the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "ResourceRelationCode":{
            "description":"The unique code for the related communication resource.",
            "type":"string",
            "maxLength":100
        },
        "ResourceRelationId":{
            "description":"The unique identifier for the related communication resource. This is automatically generated by the application.",
            "type":"integer",
            "format":"int64"
        },
        "SeedDataLock":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "description":"Indicates the source of the seed data.",
            "type":"string",
            "maxLength":512
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top