Jump to

• Request
• Response

Update an additional text

patch

/fscmRestApi/resources/11.13.18.05/paymentPlanSetups/{PaymentPlanId}/child/additionalTexts/{PlanAdditionalTextId}

Request

Path Parameters

• PaymentPlanId(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=
• PlanAdditionalTextId(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

• AdditionalTextTypeCode: string
  Title: Additional Text Type Code

  Maximum Length: 30

  The code for the type of descriptive text.
• Sequence: integer (int32)
  Title: Sequence

  Default Value: 1

  The sequence of the descriptive text.
• TextContent: string (byte)
  Title: Text Content

  The content of the descriptive text.

{
    "type":"object",
    "properties":{
        "AdditionalTextTypeCode":{
            "title":"Additional Text Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of descriptive text.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence of the descriptive text.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            }
        },
        "TextContent":{
            "title":"Text Content",
            "type":"string",
            "description":"The content of the descriptive text.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        }
    }
}

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 : paymentPlanSetups-additionalTexts-item-response

Type: object

Show Source

• AdditionalTextTypeCode: string
  Title: Additional Text Type Code

  Maximum Length: 30

  The code for the type of descriptive text.
• AdditionalTextTypeMeaning: string
  Title: Additional Text Type

  Read Only: true

  Maximum Length: 80

  The type of descriptive rich-text provided to payers during enrollment. Text can be a summary, a longer plain-language description, or formal terms and condition.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanAdditionalTextId: integer (int64)
  Title: Plan Additional Text ID

  Read Only: true

  The unique identifier of a rich-text field describing the plan or plan terms and conditions.
• Sequence: integer (int32)
  Title: Sequence

  Default Value: 1

  The sequence of the descriptive text.
• TextContent: string (byte)
  Title: Text Content

  The content of the descriptive text.

{
    "type":"object",
    "properties":{
        "AdditionalTextTypeCode":{
            "title":"Additional Text Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code for the type of descriptive text.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdditionalTextTypeMeaning":{
            "title":"Additional Text Type",
            "maxLength":80,
            "type":"string",
            "description":"The type of descriptive rich-text provided to payers during enrollment. Text can be a summary, a longer plain-language description, or formal terms and condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PlanAdditionalTextId":{
            "title":"Plan Additional Text ID",
            "type":"integer",
            "description":"The unique identifier of a rich-text field describing the plan or plan terms and conditions.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Sequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The sequence of the descriptive text.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "TextContent":{
            "title":"Text Content",
            "type":"string",
            "description":"The content of the descriptive text.",
            "format":"byte",
            "nullable":false,
            "x-queryable":false
        },
        "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

additionalTextTypeCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/genericLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HES_PAYMENT_PLAN_TEXT

Additional text is rich-text that provides a summary of a plan, a plain-language description of a plan, or the terms and conditions.

Back to Top