Jump to

• Request
• Response

Create refund process

post

/fscmRestApi/resources/11.13.18.05/hedRefunds

Request

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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• InputData: string
  Title: Refund Parameter

  The JSON-formatted string that contains the parameters that control how the refund process runs.
• ProcessStatusCode: string
  Title: Process Status Code

  Maximum Length: 80

  Code representing the current status of the refund process.
• RefundDescription: string
  Title: Refund Description

  Maximum Length: 1000

  User-defined description of the refund process.
• RefundName: string
  Title: Refund Name

  Maximum Length: 50

  User-defined name of the refund process.

{
    "type":"object",
    "properties":{
        "RefundName":{
            "title":"Refund Name",
            "maxLength":50,
            "type":"string",
            "description":"User-defined name of the refund process.",
            "nullable":false
        },
        "ProcessStatusCode":{
            "title":"Process Status Code",
            "maxLength":80,
            "type":"string",
            "description":"Code representing the current status of the refund process.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ProcessId"
                ]
            }
        },
        "RefundDescription":{
            "title":"Refund Description",
            "maxLength":1000,
            "type":"string",
            "description":"User-defined description of the refund process.",
            "nullable":false
        },
        "InputData":{
            "title":"Refund Parameter",
            "type":"string",
            "description":"The JSON-formatted string that contains the parameters that control how the refund process runs.",
            "nullable":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 : hedRefunds-item-response

Type: object

Show Source

• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time of the creation of the row.
• InputData: string
  Title: Refund Parameter

  The JSON-formatted string that contains the parameters that control how the refund process runs.
• IsDeletableFlag: boolean
  Title: Can Be Deleted

  Read Only: true

  Maximum Length: 1

  Indicates if a process is in a status where the delete action is valid. The value can be true or false based on whether the process is successful or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LogContents: string (byte)
  Title: Log File Contents

  Read Only: true

  An attachment with the contents of the ESS log file for the process.
• LogFileName: string
  Title: Log File Name

  Read Only: true

  Maximum Length: 255

  Name of the log file for the refund ESS process.
• ProcessId: integer (int64)
  Title: Process ID

  Read Only: true

  Unique identifier of the scheduled process request. For Oracle Enterprise Scheduler ESS, this column stores the job request ID returned by ESS.
• ProcessStatusCode: string
  Title: Process Status Code

  Maximum Length: 80

  Code representing the current status of the refund process.
• ProcessStatusMeaning: string
  Title: Process Status Meaning

  Read Only: true

  Maximum Length: 80

  Meaning associated with the process status code.
• RefundDescription: string
  Title: Refund Description

  Maximum Length: 1000

  User-defined description of the refund process.
• RefundHeaderId: integer (int64)
  Title: Refund ID

  Read Only: true

  Unique identifier of the higher education refund process.
• RefundName: string
  Title: Refund Name

  Maximum Length: 50

  User-defined name of the refund process.

{
    "type":"object",
    "properties":{
        "ProcessStatusMeaning":{
            "title":"Process Status Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning associated with the process status code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ProcessStatusCode",
                    "ProcessId"
                ]
            }
        },
        "LogContents":{
            "title":"Log File Contents",
            "type":"string",
            "description":"An attachment with the contents of the ESS log file for the process.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RefundName":{
            "title":"Refund Name",
            "maxLength":50,
            "type":"string",
            "description":"User-defined name of the refund process.",
            "nullable":false,
            "x-queryable":true
        },
        "ProcessStatusCode":{
            "title":"Process Status Code",
            "maxLength":80,
            "type":"string",
            "description":"Code representing the current status of the refund process.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ProcessId"
                ]
            }
        },
        "RefundHeaderId":{
            "title":"Refund ID",
            "type":"integer",
            "description":"Unique identifier of the higher education refund process.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "IsDeletableFlag":{
            "title":"Can Be Deleted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if a process is in a status where the delete action is valid. The value can be true or false based on whether the process is successful or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ProcessStatusCode"
                ]
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"Unique identifier of the scheduled process request. For Oracle Enterprise Scheduler ESS, this column stores the job request ID returned by ESS.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RefundDescription":{
            "title":"Refund Description",
            "maxLength":1000,
            "type":"string",
            "description":"User-defined description of the refund process.",
            "nullable":false,
            "x-queryable":true
        },
        "InputData":{
            "title":"Refund Parameter",
            "type":"string",
            "description":"The JSON-formatted string that contains the parameters that control how the refund process runs.",
            "nullable":false,
            "x-queryable":true
        },
        "LogFileName":{
            "title":"Log File Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the log file for the refund ESS process.",
            "nullable":true,
            "readOnly":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