Jump to

• Request
• Response

Update a corrective action

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCorrectiveActions/{publicSectorCorrectiveActionsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorCorrectiveActionsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and CorrectiveActionCode ---for the Corrective Actions resource and used to uniquely identify an instance of Corrective Actions. The client should not generate the hash key value. Instead, the client should query on the Corrective Actions collection resource with a filter on the primary key values in order to navigate to a specific instance of Corrective Actions.
  
  For example: publicSectorCorrectiveActions?q=AgencyId=<value1>;CorrectiveActionCode=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorCorrectiveActions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the agency record.
• CorrectiveActionCode(optional): string
  Title: Corrective Action ID

  Maximum Length: 100

  The corrective action code of the record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• Description(optional): string
  Title: Description

  The description of the corrective action.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the corrective action is available for use.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Name(optional): string
  Title: Summary

  Maximum Length: 200

  The name of the corrective action.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency record.",
            "title":"Agency ID"
        },
        "CorrectiveActionCode":{
            "maxLength":100,
            "type":"string",
            "description":"The corrective action code of the record.",
            "title":"Corrective Action ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Description":{
            "type":"string",
            "description":"The description of the corrective action.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the corrective action is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Name":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the corrective action.",
            "title":"Summary"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorCorrectiveActions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the agency record.
• CorrectiveActionCode(optional): string
  Title: Corrective Action ID

  Maximum Length: 100

  The corrective action code of the record.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• Description(optional): string
  Title: Description

  The description of the corrective action.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the corrective action is available for use.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations
• Name(optional): string
  Title: Summary

  Maximum Length: 200

  The name of the corrective action.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the agency record.",
            "title":"Agency ID"
        },
        "CorrectiveActionCode":{
            "maxLength":100,
            "type":"string",
            "description":"The corrective action code of the record.",
            "title":"Corrective Action ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "Description":{
            "type":"string",
            "description":"The description of the corrective action.",
            "title":"Description"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the corrective action is available for use.",
            "title":"Enabled"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "Name":{
            "maxLength":200,
            "type":"string",
            "description":"The name of the corrective action.",
            "title":"Summary"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top