Jump to

• Request
• Response

Update a record assignment in the project

patch

/fscmRestApi/resources/11.13.18.05/publicSectorProjectRecords/{publicSectorProjectRecordsUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorProjectRecords-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the public sector agency.
• Classification(optional): string
  Maximum Length: 3

  The classification of the record type.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the record was created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the record was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• ProjectCode(optional): string
  Title: Project ID

  Maximum Length: 30

  The unique identifier of the project.
• RecordId(optional): string
  Maximum Length: 50

  The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.
• RecordKey(optional): integer(int64)
  The unique identifier of the record.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency."
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the record type."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "title":"Last Updated Date"
        },
        "ProjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the project.",
            "title":"Project ID"
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the application record. The value is generated based on the auto number rule configured for the type of record."
        },
        "RecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record."
        },
        "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 : publicSectorProjectRecords-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  The unique identifier of the public sector agency.
• Classification(optional): string
  Maximum Length: 3

  The classification of the record type.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the record was created.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the record was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• ProjectCode(optional): string
  Title: Project ID

  Maximum Length: 30

  The unique identifier of the project.
• RecordId(optional): string
  Maximum Length: 50

  The identifier of the application record. The value is generated based on the auto number rule configured for the type of record.
• RecordKey(optional): integer(int64)
  The unique identifier of the record.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency."
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the record type."
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "title":"Last Updated Date"
        },
        "ProjectCode":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the project.",
            "title":"Project ID"
        },
        "RecordId":{
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the application record. The value is generated based on the auto number rule configured for the type of record."
        },
        "RecordKey":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the record."
        },
        "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