Jump to

• Request
• Response

Update a record assignment in the project

patch

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

Request

Path Parameters

• publicSectorProjectRecordsUniqID(required): string
  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>

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Classification: string
  Maximum Length: 3

  The classification of the record type.
• RecordId: 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.

{
    "type":"object",
    "properties":{
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the record type.",
            "nullable":false
        },
        "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.",
            "nullable":true
        }
    }
}

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 : publicSectorProjectRecords-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  Default Value: 1

  The unique identifier of the public sector agency.
• Classification: string
  Maximum Length: 3

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

  Read Only: true

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

  Read Only: true

  The date and time when the record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProjectCode: string
  Title: Project ID

  Maximum Length: 30

  The unique identifier of the project.
• RecordId: 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: integer (int64)
  The unique identifier of the record.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "format":"int32",
            "nullable":false,
            "default":1,
            "x-hints":{
                "precision":8
            },
            "x-queryable":true
        },
        "RecordKey":{
            "type":"integer",
            "description":"The unique identifier of the record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProjectCode":{
            "title":"Project ID",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the project.",
            "nullable":false,
            "x-queryable":true
        },
        "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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "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