REST API for Common Features in Oracle Fusion Cloud Applications

Update a set ID reference group

patch

http://servername/fscmRestApi/resources/11.13.18.05/setIdReferenceGroups/{setIdReferenceGroups_Id}

update

Request

Path Parameters

setIdReferenceGroups_Id(required): string

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=

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/vnd.oracle.adf.resourceitem+json
application/json

Root Schema : schema

Type: object

Show Source

ApplicationId: integer (int64)

The unique identifier of the application.
ApplicationShortName: string

Read Only: true

Maximum Length: 50

The short name of the application.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Read Only: true

The date when the record was created.
Description: string

Maximum Length: 240

The description of the reference group.
DeterminantType: string

Maximum Length: 30

The unique identifier of the determinant type.
LastUpdateDate: string (date-time)

Read Only: true

The date when the record was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

The login credentials of the person who last updated the record.
ModuleId: string

Maximum Length: 32

The unique identifier of the set ID module.
ReferenceGroupName: string

Maximum Length: 30

The unique identifier of the set ID reference group.
VisibleGroupName: string

Maximum Length: 80

The translated visible name of the set ID reference group.

{ "type":"object", "properties":{ "ReferenceGroupName":{ "maxLength":30, "type":"string", "description":"The unique identifier of the set ID reference group.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true } }, "VisibleGroupName":{ "maxLength":80, "type":"string", "description":"The translated visible name of the set ID reference group.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "fnd:OA_TRANSLATABLE":"true" } } }, "Description":{ "maxLength":240, "type":"string", "description":"The description of the reference group.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ModuleId":{ "maxLength":32, "type":"string", "description":"The unique identifier of the set ID module.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true } }, "DeterminantType":{ "maxLength":30, "type":"string", "description":"The unique identifier of the determinant type.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true } }, "ApplicationId":{ "type":"integer", "description":"The unique identifier of the application.", "format":"int64", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true, "adf-precision":18 } }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"The user who created the record.", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "CreationDate":{ "type":"string", "description":"The date when the record was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "LastUpdateDate":{ "type":"string", "description":"The date when the record was last updated.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "LastUpdateLogin":{ "maxLength":32, "type":"string", "description":"The login credentials of the person who last updated the record.", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"The user who last updated the record.", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ApplicationShortName":{ "maxLength":50, "type":"string", "description":"The short name of the application.", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } } }, "x-hints":{ "titlePlural":"Set ID Reference Groups" } }

Root Schema : schema

Type: object

Show Source

ApplicationId: integer (int64)

The unique identifier of the application.
ApplicationShortName: string

Read Only: true

Maximum Length: 50

The short name of the application.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Read Only: true

The date when the record was created.
Description: string

Maximum Length: 240

The description of the reference group.
DeterminantType: string

Maximum Length: 30

The unique identifier of the determinant type.
LastUpdateDate: string (date-time)

Read Only: true

The date when the record was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

The login credentials of the person who last updated the record.
ModuleId: string

Maximum Length: 32

The unique identifier of the set ID module.
ReferenceGroupName: string

Maximum Length: 30

The unique identifier of the set ID reference group.
VisibleGroupName: string

Maximum Length: 80

The translated visible name of the set ID reference group.

{ "type":"object", "properties":{ "ReferenceGroupName":{ "maxLength":30, "type":"string", "description":"The unique identifier of the set ID reference group.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true } }, "VisibleGroupName":{ "maxLength":80, "type":"string", "description":"The translated visible name of the set ID reference group.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "fnd:OA_TRANSLATABLE":"true" } } }, "Description":{ "maxLength":240, "type":"string", "description":"The description of the reference group.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ModuleId":{ "maxLength":32, "type":"string", "description":"The unique identifier of the set ID module.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true } }, "DeterminantType":{ "maxLength":30, "type":"string", "description":"The unique identifier of the determinant type.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true } }, "ApplicationId":{ "type":"integer", "description":"The unique identifier of the application.", "format":"int64", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true, "adf-precision":18 } }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"The user who created the record.", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "CreationDate":{ "type":"string", "description":"The date when the record was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "LastUpdateDate":{ "type":"string", "description":"The date when the record was last updated.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "LastUpdateLogin":{ "maxLength":32, "type":"string", "description":"The login credentials of the person who last updated the record.", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"The user who last updated the record.", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ApplicationShortName":{ "maxLength":50, "type":"string", "description":"The short name of the application.", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } } }, "x-hints":{ "titlePlural":"Set ID Reference Groups" } }

Response

Supported Media Types

application/vnd.oracle.adf.resourceitem+json
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.

Root Schema : setIdReferenceGroups-item-response

Match All

Show Source

object ItemProperties
object schema

{ "allOf":[ { "$ref":"#/components/schemas/ItemProperties" }, { "$ref":"#/components/schemas/setIdReferenceGroups-item" } ] }

Nested Schema : ItemProperties

Type: object

Show Source

links: array Links

Title: Links

The link relations associated with the resource instance.

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } } } }

Nested Schema : schema

Type: object

Show Source

ApplicationId: integer (int64)

The unique identifier of the application.
ApplicationShortName: string

Read Only: true

Maximum Length: 50

The short name of the application.
CreatedBy: string

Read Only: true

Maximum Length: 64

The user who created the record.
CreationDate: string (date-time)

Read Only: true

The date when the record was created.
Description: string

Maximum Length: 240

The description of the reference group.
DeterminantType: string

Maximum Length: 30

The unique identifier of the determinant type.
LastUpdateDate: string (date-time)

Read Only: true

The date when the record was last updated.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

The user who last updated the record.
LastUpdateLogin: string

Read Only: true

Maximum Length: 32

The login credentials of the person who last updated the record.
ModuleId: string

Maximum Length: 32

The unique identifier of the set ID module.
ReferenceGroupName: string

Maximum Length: 30

The unique identifier of the set ID reference group.
VisibleGroupName: string

Maximum Length: 80

The translated visible name of the set ID reference group.

{ "type":"object", "properties":{ "ReferenceGroupName":{ "maxLength":30, "type":"string", "description":"The unique identifier of the set ID reference group.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true } }, "VisibleGroupName":{ "maxLength":80, "type":"string", "description":"The translated visible name of the set ID reference group.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "fnd:OA_TRANSLATABLE":"true" } } }, "Description":{ "maxLength":240, "type":"string", "description":"The description of the reference group.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ModuleId":{ "maxLength":32, "type":"string", "description":"The unique identifier of the set ID module.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true } }, "DeterminantType":{ "maxLength":30, "type":"string", "description":"The unique identifier of the determinant type.", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true } }, "ApplicationId":{ "type":"integer", "description":"The unique identifier of the application.", "format":"int64", "nullable":false, "x-queryable":true, "x-hints":{ "updatable":true, "adf-precision":18 } }, "CreatedBy":{ "maxLength":64, "type":"string", "description":"The user who created the record.", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "CreationDate":{ "type":"string", "description":"The date when the record was created.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "LastUpdateDate":{ "type":"string", "description":"The date when the record was last updated.", "format":"date-time", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "LastUpdateLogin":{ "maxLength":32, "type":"string", "description":"The login credentials of the person who last updated the record.", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "LastUpdatedBy":{ "maxLength":64, "type":"string", "description":"The user who last updated the record.", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ApplicationShortName":{ "maxLength":50, "type":"string", "description":"The short name of the application.", "nullable":false, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } } }, "x-hints":{ "titlePlural":"Set ID Reference Groups" } }

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." } } }