Jump to

• Request
• Response

Update a result

patch

/fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/results/{resultsUniqID}

Request

Path Parameters

• courseListsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Course Lists resource and used to uniquely identify an instance of Course Lists. The client should not generate the hash key value. Instead, the client should query on the Course Lists collection resource in order to navigate to a specific instance of Course Lists to get the hash key.
• resultsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Results resource and used to uniquely identify an instance of Results. The client should not generate the hash key value. Instead, the client should query on the Results collection resource in order to navigate to a specific instance of Results to get the hash key.

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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

• DefaultResultSetFlag: boolean
  Title: Default Result Set Indicator

  Maximum Length: 1

  Indicates the default result set for a scheduled course or course offering. The default value is false.
• ResultId: integer (int64)
  Title: Curriculum Result ID

  The unique identifier for a curriculum result record.
• ResultSetId: integer (int64)
  Title: Result Set ID

  The unique identifier for a result set.
• ResultTypeId: integer (int64)
  Title: Result Type ID

  The unique identifier for a result type.

{
    "type":"object",
    "properties":{
        "DefaultResultSetFlag":{
            "title":"Default Result Set Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the default result set for a scheduled course or course offering. The default value is false.",
            "nullable":false
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier for a result set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResultId":{
            "title":"Curriculum Result ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum result record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ResultTypeId":{
            "title":"Result Type ID",
            "type":"integer",
            "description":"The unique identifier for a result type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : courseLists-results-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row for the result.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the result row was created.
• DefaultResultSetFlag: boolean
  Title: Default Result Set Indicator

  Maximum Length: 1

  Indicates the default result set for a scheduled course or course offering. The default value is false.
• LastUpdateDate: string (date-time)
  Title: Last Updated By

  Read Only: true

  The date and time when the result row was last updated.
• LastUpdatedBy: string
  Title: Last Updated Date

  Read Only: true

  Maximum Length: 64

  The user who last updated the row for the result.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResultId: integer (int64)
  Title: Curriculum Result ID

  The unique identifier for a curriculum result record.
• ResultSetCode: string
  Title: Result Set Code

  Read Only: true

  Maximum Length: 30

  The unique code for a result set.
• ResultSetId: integer (int64)
  Title: Result Set ID

  The unique identifier for a result set.
• ResultSetName: string
  Title: Result Set Name

  Read Only: true

  Maximum Length: 50

  The name of a result set.
• ResultTypeCode: string
  Title: Result Type Code

  Read Only: true

  Maximum Length: 30

  The unique code for a result type.
• ResultTypeId: integer (int64)
  Title: Result Type ID

  The unique identifier for a result type.
• ResultTypeName: string
  Title: Result Type Name

  Read Only: true

  Maximum Length: 50

  The name of a result type.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated Date",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the row for the result.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the result row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultResultSetFlag":{
            "title":"Default Result Set Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the default result set for a scheduled course or course offering. The default value is false.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the row for the result.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultId":{
            "title":"Curriculum Result ID",
            "type":"integer",
            "description":"The unique identifier for a curriculum result record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResultSetCode":{
            "title":"Result Set Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for a result set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultTypeCode":{
            "title":"Result Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for a result type.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ResultTypeName":{
            "title":"Result Type Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a result type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultSetId":{
            "title":"Result Set ID",
            "type":"integer",
            "description":"The unique identifier for a result set.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResultSetName":{
            "title":"Result Set Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of a result set.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResultTypeId":{
            "title":"Result Type ID",
            "type":"integer",
            "description":"The unique identifier for a result type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The date and time when the result row 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