Jump to

• Request
• Response

Update a related communication resource

patch

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

Request

Path Parameters

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

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

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

Root Schema : schema

Type: object

Show Source

• AnchorFifthKeyName: string
  Maximum Length: 100

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

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

  The fourth key name of the anchor communication resource.
• AnchorResourceId: integer (int64)
  The anchor resource identifier.
• AnchorSecondKeyName: string
  Maximum Length: 100

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

  The third key name of the anchor communication resource.
• ContactTypeResFlag: 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: 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.
• ModuleId: 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: string
  Maximum Length: 100

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

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

  The fourth key name of the related communication resource.
• RelatedResourceId: integer (int64)
  The related resource identifier.
• RelatedSecondKeyName: string
  Maximum Length: 100

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

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

  The unique code for the related communication resource.
• SeedDataLock: 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: string
  Maximum Length: 512

  Indicates the source of the seed data.

{
    "type":"object",
    "properties":{
        "AnchorFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the anchor communication resource.",
            "nullable":true
        },
        "RelatedResourceId":{
            "type":"integer",
            "description":"The related resource identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelatedFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the related communication resource.",
            "nullable":true
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"Indicates the source of the seed data.",
            "nullable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            }
        },
        "RelatedThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the related communication resource.",
            "nullable":true
        },
        "RelatedFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the related communication resource.",
            "nullable":true
        },
        "AnchorThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the anchor communication resource.",
            "nullable":true
        },
        "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.",
            "nullable":false
        },
        "AnchorFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the anchor communication resource.",
            "nullable":true
        },
        "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.",
            "nullable":true
        },
        "AnchorResourceId":{
            "type":"integer",
            "description":"The anchor resource identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResourceRelationCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique code for the related communication resource.",
            "nullable":false
        },
        "RelatedFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the related communication resource.",
            "nullable":true
        },
        "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.",
            "nullable":false
        },
        "AnchorFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the anchor communication resource.",
            "nullable":true
        },
        "RelatedSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the related communication resource.",
            "nullable":true
        },
        "AnchorSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the anchor communication resource.",
            "nullable":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : publicSectorCommunicationResources-CommResourceRelations-item-response

Type: object

Show Source

• AnchorFifthKeyName: string
  Maximum Length: 100

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

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

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

  Read Only: true

  Maximum Length: 32

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

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

  The third key name of the anchor communication resource.
• ContactTypeResFlag: 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: 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: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: 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: string
  Maximum Length: 100

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

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

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

  Read Only: true

  Maximum Length: 32

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

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

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

  The unique code for the related communication resource.
• ResourceRelationId: integer (int64)
  The unique identifier for the related communication resource. This is automatically generated by the application.
• SeedDataLock: 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: string
  Maximum Length: 512

  Indicates the source of the seed data.

{
    "type":"object",
    "properties":{
        "AnchorResourceCode":{
            "title":"Resource Code",
            "maxLength":32,
            "type":"string",
            "description":"The anchor resource code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnchorFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedResourceCode":{
            "title":"Resource Code",
            "maxLength":32,
            "type":"string",
            "description":"The related resource code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelatedResourceId":{
            "type":"integer",
            "description":"The related resource identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelatedFirstKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The first key name of the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataSource":{
            "maxLength":512,
            "type":"string",
            "description":"Indicates the source of the seed data.",
            "nullable":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "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.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "RelatedThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "AnchorThirdKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The third key name of the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "x-queryable":true
        },
        "AnchorFourthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fourth key name of the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "AnchorResourceId":{
            "type":"integer",
            "description":"The anchor resource identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceRelationCode":{
            "maxLength":100,
            "type":"string",
            "description":"The unique code for the related communication resource.",
            "nullable":false,
            "x-queryable":true
        },
        "RelatedFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "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.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AnchorFifthKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The fifth key name of the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "RelatedSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the related communication resource.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceRelationId":{
            "type":"integer",
            "description":"The unique identifier for the related communication resource. This is automatically generated by the application.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "AnchorSecondKeyName":{
            "maxLength":100,
            "type":"string",
            "description":"The second key name of the anchor communication resource.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top