Jump to

• Request
• Response

Update a related record type

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec/{RelatedRecUniqID}

Request

Supported Media Types

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

Path Parameters

• RecordTypeId: string
  The unique identifier for the record type.
• RelatedRecUniqID: integer
  This is the hash key of the attributes which make up the composite key--- RecordTypeId and RelatedTypeId ---for the Related Record Types resource and used to uniquely identify an instance of Related Record Types. The client should not generate the hash key value. Instead, the client should query on the Related Record Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Related Record Types.
  
  For example: RelatedRec?q=RecordTypeId=<value1>;RelatedTypeId=<value2>

Body ()

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

Root Schema : publicSectorRecordTypes-RelatedRec-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with the related record type.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  The date when the related record type was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Link Relations
• RecordTypeId(optional): string
  Title: Record Type ID

  Maximum Length: 30

  The unique identifier for the record type.
• RelatedTypeId(optional): string
  Title: Related Record Type ID

  Maximum Length: 30

  The unique identifier for the related record type.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the related record type.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the related record type.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related record type was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related record type was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the related record type.",
            "title":"Last Updated By"
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the record type.",
            "title":"Record Type ID"
        },
        "RelatedTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the related record type.",
            "title":"Related Record Type ID"
        },
        "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 : publicSectorRecordTypes-RelatedRec-item

Type: object

Show Source

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

  The identifier for the public sector agency associated with the related record type.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

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

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

  The date when the related record type was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

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

  Link Relations
• RecordTypeId(optional): string
  Title: Record Type ID

  Maximum Length: 30

  The unique identifier for the record type.
• RelatedTypeId(optional): string
  Title: Related Record Type ID

  Maximum Length: 30

  The unique identifier for the related record type.

{
    "properties":{
        "AgencyId":{
            "format":"int64",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the related record type.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the related record type.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related record type was created.",
            "title":"Creation Date"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related record type was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the related record type.",
            "title":"Last Updated By"
        },
        "RecordTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the record type.",
            "title":"Record Type ID"
        },
        "RelatedTypeId":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier for the related record type.",
            "title":"Related Record Type ID"
        },
        "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