Jump to

• Request
• Response

Update a function

patch

/fscmRestApi/resources/11.13.18.05/publicSectorFunctions/{publicSectorFunctionsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorFunctions-item

Type: object

Show Source

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

  The unique identifier of the agency associated with the function. Value is mandatory and is set programmatically based on the user's login.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  Maximum Length: 100

  The description of the function.
• FunctionId(optional): string
  Title: Function

  Maximum Length: 30

  The unique identifier of the function. Identifies the public service for which an agency is responsible associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• ValidFromDate(optional): string(date-time)
  Title: From Date

  The first day the value may be used.
• ValidToDate(optional): string(date-time)
  Title: To Date

  The last day the value may be used.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the function. Value is mandatory and is set programmatically based on the user's login.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the function.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the function was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the function.",
            "title":"Description"
        },
        "FunctionId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the function. Identifies the public service for which an agency is responsible associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.",
            "title":"Function"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the function was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the function.",
            "title":"Last Updated By"
        },
        "ValidFromDate":{
            "format":"date-time",
            "type":"string",
            "description":"The first day the value may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last day the value may be used.",
            "title":"To Date"
        },
        "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 : publicSectorFunctions-item

Type: object

Show Source

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

  The unique identifier of the agency associated with the function. Value is mandatory and is set programmatically based on the user's login.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  Maximum Length: 100

  The description of the function.
• FunctionId(optional): string
  Title: Function

  Maximum Length: 30

  The unique identifier of the function. Identifies the public service for which an agency is responsible associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

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

  Maximum Length: 64

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

  Link Relations
• ValidFromDate(optional): string(date-time)
  Title: From Date

  The first day the value may be used.
• ValidToDate(optional): string(date-time)
  Title: To Date

  The last day the value may be used.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with the function. Value is mandatory and is set programmatically based on the user's login.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the function.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the function was created.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the function.",
            "title":"Description"
        },
        "FunctionId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the function. Identifies the public service for which an agency is responsible associated with an accounting transaction. Value is mandatory and is defined by the user during a create action.",
            "title":"Function"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time the function was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the function.",
            "title":"Last Updated By"
        },
        "ValidFromDate":{
            "format":"date-time",
            "type":"string",
            "description":"The first day the value may be used.",
            "title":"From Date"
        },
        "ValidToDate":{
            "format":"date-time",
            "type":"string",
            "description":"The last day the value may be used.",
            "title":"To Date"
        },
        "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