Jump to

• Request
• Response

Update a race

patch

/fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/races/{PersonalRaceId}

Request

Path Parameters

• PartyId(required): integer(int64)
  The unique identifier for the party. Party can be a person. For example, a student can be a party.
• PersonalRaceId(required): integer(int64)
  The unique identifier of person's race.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• RaceCode: string
  Title: Race

  Maximum Length: 30

  The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE.
• RaceValue: string
  Maximum Length: 100

  The race value for a person.

{
    "type":"object",
    "properties":{
        "RaceValue":{
            "maxLength":100,
            "type":"string",
            "description":"The race value for a person.",
            "nullable":true
        },
        "RaceCode":{
            "title":"Race",
            "maxLength":30,
            "type":"string",
            "description":"The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  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(required):
  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 : personProfiles-races-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonalRaceId: integer (int64)
  Title: Personal Race ID

  Read Only: true

  The unique identifier of person's race.
• RaceCode: string
  Title: Race

  Maximum Length: 30

  The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE.
• RaceCodeMeaning: string
  Title: Race

  Read Only: true

  Maximum Length: 80

  The meaning of race. A list of accepted values is defined in the lookup type ORA_HEY_RACE.
• RaceValue: string
  Maximum Length: 100

  The race value for a person.

{
    "type":"object",
    "properties":{
        "RaceValue":{
            "maxLength":100,
            "type":"string",
            "description":"The race value for a person.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PersonalRaceId":{
            "title":"Personal Race ID",
            "type":"integer",
            "description":"The unique identifier of person's race.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RaceCode":{
            "title":"Race",
            "maxLength":30,
            "type":"string",
            "description":"The race of the person. A list of accepted values is defined in the lookup type ORA_HEY_RACE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RaceCodeMeaning":{
            "title":"Race",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of race. A list of accepted values is defined in the lookup type ORA_HEY_RACE.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "LookupCode"
                ]
            },
            "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."
        }
    }
}

Links

RaceCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupType%3DORA_HEY_RACE%2CLookupCode%3D{RaceCode}

The following properties are defined on the LOV link relation:

• Source Attribute: RaceCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top