Jump to

• Request
• Response

Update a communication channel property

patch

/fscmRestApi/resources/11.13.18.05/hedCommunicationSetups/{CommunicationSetupId}/child/commVersions/{VersionId}/child/commChannels/{CommChannelId}/child/commContentProperties/{PropertyId}

Request

Path Parameters

• CommChannelId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• CommunicationSetupId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• PropertyId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• VersionId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  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 ()

Root Schema : schema

Type: object

Show Source

• PropertyLongValue: string (byte)
  Title: Property Long Value

  Communication content property long value.
• PropertyTypeCode: string
  Title: Property Type Code

  Maximum Length: 30

  Type of the communication content property.
• PropertyValue: string
  Title: Property Value

  Maximum Length: 1000

  Communication content property value.

{
    "type":"object",
    "properties":{
        "PropertyLongValue":{
            "title":"Property Long Value",
            "type":"string",
            "description":"Communication content property long value.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PropertyTypeCode":{
            "title":"Property Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Type of the communication content property.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":1000,
            "type":"string",
            "description":"Communication content property value.",
            "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:
  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.

Body ()

Root Schema : hedCommunicationSetups-commVersions-commChannels-commContentProperties-item-response

Type: object

Show Source

• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the communication content property was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the communication content property.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PropertyId: integer (int64)
  Title: Property ID

  Read Only: true

  Communication setup content identifier for a channel property.
• PropertyLongValue: string (byte)
  Title: Property Long Value

  Communication content property long value.
• PropertyName: string
  Title: Property Name

  Maximum Length: 64

  Name of the property.
• PropertyTypeCode: string
  Title: Property Type Code

  Maximum Length: 30

  Type of the communication content property.
• PropertyTypeMeaning: string
  Title: Property Type Code Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the communication content property type. Example of content types are short and long.
• PropertyValue: string
  Title: Property Value

  Maximum Length: 1000

  Communication content property value.

{
    "type":"object",
    "properties":{
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the communication content property was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the communication content property.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyId":{
            "title":"Property ID",
            "type":"integer",
            "description":"Communication setup content identifier for a channel property.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PropertyLongValue":{
            "title":"Property Long Value",
            "type":"string",
            "description":"Communication content property long value.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PropertyName":{
            "title":"Property Name",
            "maxLength":64,
            "type":"string",
            "description":"Name of the property.",
            "nullable":false,
            "x-queryable":true
        },
        "PropertyTypeCode":{
            "title":"Property Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Type of the communication content property.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PropertyTypeMeaning":{
            "title":"Property Type Code Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the communication content property type. Example of content types are short and long.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PropertyValue":{
            "title":"Property Value",
            "maxLength":1000,
            "type":"string",
            "description":"Communication content property value.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Links

PropertyTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_COMM_CONTENT_TYPE_CODE%2CLookupCode%3D{PropertyTypeCode}

The following properties are defined on the LOV link relation:

• Source Attribute: PropertyTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top