Jump to

• Request
• Response

Update an application long text item

patch

/fscmRestApi/resources/11.13.18.05/admissionApplications/{ApplicationId}/child/applicationLongTextItems/{ApplicationClobDataId}

Request

Path Parameters

• ApplicationClobDataId(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=
• ApplicationId(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

• CategoryCode: string
  Title: Category Code

  Maximum Length: 30

  Identifies the category of the long text data.
• ClobData: string (byte)
  Title: Long Text

  The long text data associated with the application.
• ClobMetadata: string (byte)
  Title: Long Text Metadata

  Additional information about the long text data stored and utilized by the owning functional area.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the category of the long text data.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ClobData":{
            "title":"Long Text",
            "type":"string",
            "description":"The long text data associated with the application.",
            "format":"byte",
            "nullable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "ClobMetadata":{
            "title":"Long Text Metadata",
            "type":"string",
            "description":"Additional information about the long text data stored and utilized by the owning functional area.",
            "format":"byte",
            "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 : admissionApplications-applicationLongTextItems-item-response

Type: object

Show Source

• ApplicationClobDataId: integer (int64)
  Title: Long Text Item ID

  Read Only: true

  Unique identifier for a long text data item associated with an application.
• CategoryCode: string
  Title: Category Code

  Maximum Length: 30

  Identifies the category of the long text data.
• CategoryCodeMeaning: string
  Title: Category

  Read Only: true

  Maximum Length: 80

  The name of the long text category.
• ClobData: string (byte)
  Title: Long Text

  The long text data associated with the application.
• ClobMetadata: string (byte)
  Title: Long Text Metadata

  Additional information about the long text data stored and utilized by the owning functional area.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RequestAction: string
  Title: Request Action

  Maximum Length: 80

  The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.

{
    "type":"object",
    "properties":{
        "CategoryCode":{
            "title":"Category Code",
            "maxLength":30,
            "type":"string",
            "description":"Identifies the category of the long text data.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequestAction":{
            "title":"Request Action",
            "maxLength":80,
            "type":"string",
            "description":"The request action that's performed when passed by the client during an update. When set to DELETE, the record is deleted. The only accepted value for request action is DELETE.",
            "nullable":true,
            "x-queryable":false
        },
        "ClobMetadata":{
            "title":"Long Text Metadata",
            "type":"string",
            "description":"Additional information about the long text data stored and utilized by the owning functional area.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ClobData":{
            "title":"Long Text",
            "type":"string",
            "description":"The long text data associated with the application.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CategoryCodeMeaning":{
            "title":"Category",
            "maxLength":80,
            "type":"string",
            "description":"The name of the long text category.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ApplicationClobDataId":{
            "title":"Long Text Item ID",
            "type":"integer",
            "description":"Unique identifier for a long text data item associated with an application.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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."
        }
    }
}

Links

CategoryCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heqLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEQ_LONG_TEXT_CATEGORY%2CLookupCode%3D{CategoryCode}

The following properties are defined on the LOV link relation:

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

Back to Top