Jump to

• Request
• Response

Update a corrective action

patch

/fscmRestApi/resources/11.13.18.05/publicSectorAppealCorrectiveActions/{AplCrtvKey}

Request

Path Parameters

• AplCrtvKey(required): integer(int64)
  The unique identifier of the corrective action.

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

• CorrectiveActionDescription: string (byte)
  The user defined description of the corrective action.

{
    "type":"object",
    "properties":{
        "CorrectiveActionDescription":{
            "type":"string",
            "description":"The user defined description of the corrective action.",
            "format":"byte",
            "nullable":true,
            "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(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 : publicSectorAppealCorrectiveActions-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The identifier of the agency.
• AplCrtvKey: integer (int64)
  The unique identifier of the corrective action.
• AplCrtvPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated case appeal record.
• CaseAppealKey: integer (int64)
  The unique identifier of the case appeal.
• CaseAppealPuid: string
  Maximum Length: 480

  The public unique identifier of the migrated appeal corrective action record.
• CorrectiveActionCode: string
  Maximum Length: 100

  The system code of the corrective action.
• CorrectiveActionDescription: string (byte)
  The user defined description of the corrective action.
• CorrectiveActionName: string
  Maximum Length: 200

  The user defined name of the corrective action.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CaseAppealKey":{
            "type":"integer",
            "description":"The unique identifier of the case appeal.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorrectiveActionDescription":{
            "type":"string",
            "description":"The user defined description of the corrective action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CorrectiveActionCode":{
            "maxLength":100,
            "type":"string",
            "description":"The system code of the corrective action.",
            "nullable":false,
            "x-queryable":true
        },
        "AplCrtvPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated case appeal record.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier of the agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "CorrectiveActionName":{
            "maxLength":200,
            "type":"string",
            "description":"The user defined name of the corrective action.",
            "nullable":false,
            "x-queryable":true
        },
        "AplCrtvKey":{
            "type":"integer",
            "description":"The unique identifier of the corrective action.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CaseAppealPuid":{
            "maxLength":480,
            "type":"string",
            "description":"The public unique identifier of the migrated appeal corrective action record.",
            "nullable":false,
            "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."
        }
    }
}

Back to Top