Jump to

• Request
• Response

Update an elements group

patch

/fscmRestApi/resources/11.13.18.05/courseLists/{courseListsUniqID}/child/groups/{GroupId}

Request

Path Parameters

• GroupId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• 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.

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

• Description: string
  Maximum Length: 250

  The description for a curriculum element group.
• DisplaySequenceNumber: integer (int32)
  Default Value: 1

  The display sequence number of a curriculum group. The sequence number can be used to present element groups in a specific order.
• Name: string
  Maximum Length: 50

  The name for a curriculum element group.
• ParentSequenceId: integer (int32)
  The sequence identifier for the parent of a curriculum element group. If a user creates group ten as a group within group one, the parent ID for group ten would be the ID for group one.
• SequenceId: integer (int32)
  A sequence identifier used to identify and sort groups within a curriculum item.
• StatementCode: string
  Maximum Length: 30

  The code of the conditional operator, such as ORA_ANY or ORA_ALL for the related items and groups within a curriculum element group.

{
    "type":"object",
    "properties":{
        "ParentSequenceId":{
            "type":"integer",
            "description":"The sequence identifier for the parent of a curriculum element group. If a user creates group ten as a group within group one, the parent ID for group ten would be the ID for group one.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            }
        },
        "Description":{
            "maxLength":"250",
            "type":"string",
            "description":"The description for a curriculum element group.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "DisplaySequenceNumber":{
            "type":"integer",
            "description":"The display sequence number of a curriculum group. The sequence number can be used to present element groups in a specific order.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            }
        },
        "StatementCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the conditional operator, such as ORA_ANY or ORA_ALL for the related items and groups within a curriculum element group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            }
        },
        "SequenceId":{
            "type":"integer",
            "description":"A sequence identifier used to identify and sort groups within a curriculum item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            }
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name for a curriculum element group.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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-groups-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the element group row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the element group row was created.
• Description: string
  Maximum Length: 250

  The description for a curriculum element group.
• DisplaySequenceNumber: integer (int32)
  Default Value: 1

  The display sequence number of a curriculum group. The sequence number can be used to present element groups in a specific order.
• GroupId: integer (int64)
  Read Only: true

  The unique identifier for a curriculum element group.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the element group row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the element group row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Maximum Length: 50

  The name for a curriculum element group.
• ParentSequenceId: integer (int32)
  The sequence identifier for the parent of a curriculum element group. If a user creates group ten as a group within group one, the parent ID for group ten would be the ID for group one.
• SequenceId: integer (int32)
  A sequence identifier used to identify and sort groups within a curriculum item.
• StatementCode: string
  Maximum Length: 30

  The code of the conditional operator, such as ORA_ANY or ORA_ALL for the related items and groups within a curriculum element group.
• StatementMeaning: string
  Read Only: true

  Maximum Length: 50

  The meaning of conditional operator, such as Any or All for the related items and groups within a curriculum element group.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the element group row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the element group row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentSequenceId":{
            "type":"integer",
            "description":"The sequence identifier for the parent of a curriculum element group. If a user creates group ten as a group within group one, the parent ID for group ten would be the ID for group one.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the element group row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"250",
            "type":"string",
            "description":"The description for a curriculum element group.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StatementCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code of the conditional operator, such as ORA_ANY or ORA_ALL for the related items and groups within a curriculum element group.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StatementMeaning":{
            "maxLength":"50",
            "type":"string",
            "description":"The meaning of conditional operator, such as Any or All for the related items and groups within a curriculum element group.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"The unique identifier for a curriculum element group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Name":{
            "maxLength":"50",
            "type":"string",
            "description":"The name for a curriculum element group.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisplaySequenceNumber":{
            "type":"integer",
            "description":"The display sequence number of a curriculum group. The sequence number can be used to present element groups in a specific order.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the element group row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceId":{
            "type":"integer",
            "description":"A sequence identifier used to identify and sort groups within a curriculum item.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9",
                "PAYLOADHINT":"Show"
            },
            "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

StatementCodeLOV

Operation: /fscmRestApi/resources/11.13.18.05/artifactStatements

Parameters:

• finder: TypeFinder%3BActive%3DY%2CLogicLevel%3DORA_HEY_SIMPLE_LOGIC%2CStatementSubType%3DORA_HEY_OPERATOR%2CStatementType%3DORA_HEY_LOGIC

The following properties are defined on the LOV link relation:

• Source Attribute: StatementCode; Target Attribute: StatementCode
• Display Attribute: StatementCode

Back to Top