Jump to

• Request
• Response

Update a page group

patch

/fscmRestApi/resources/11.13.18.05/hedPageGroups/{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=

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

• GroupDescription: string
  Maximum Length: 1000

  Description of the page group.
• GroupName(required): string
  Maximum Length: 100

  Name of the page group.
• pageGroupMembers: array Page Group Members
  Title: Page Group Members

  The page group members resource is used to view, create, or modify the memberships of page groups.

{
    "required":[
        "GroupName"
    ],
    "type":"object",
    "properties":{
        "GroupName":{
            "maxLength":"100",
            "type":"string",
            "description":"Name of the page group.",
            "nullable":false
        },
        "GroupDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the page group.",
            "nullable":true
        },
        "pageGroupMembers":{
            "title":"Page Group Members",
            "type":"array",
            "description":"The page group members resource is used to view, create, or modify the memberships of page groups.",
            "items":{
                "$ref":"#/components/schemas/hedPageGroups-pageGroupMembers-item-patch-request"
            }
        }
    }
}

Nested Schema : Page Group Members

Type: array

Title: Page Group Members

The page group members resource is used to view, create, or modify the memberships of page groups.

Show Source

• Array of: object schema

{
    "title":"Page Group Members",
    "type":"array",
    "description":"The page group members resource is used to view, create, or modify the memberships of page groups.",
    "items":{
        "$ref":"#/components/schemas/hedPageGroups-pageGroupMembers-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : hedPageGroups-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Who column:The date and time when the row for the identifier was created.
• GroupDescription: string
  Maximum Length: 1000

  Description of the page group.
• GroupId: integer (int64)
  Read Only: true

  Unique identifier of the page group.
• GroupName: string
  Maximum Length: 100

  Name of the page group.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: The date and time when the row for the identifier was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: The user who last updated the row for the identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• pageGroupMembers: array Page Group Members
  Title: Page Group Members

  The page group members resource is used to view, create, or modify the memberships of page groups.
• SeedDataLock: integer (int32)
  Read Only: true

  Default Value: 0

  Identifies the row as seed data of the page group.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Who column: The user who last updated the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupName":{
            "maxLength":"100",
            "type":"string",
            "description":"Name of the page group.",
            "nullable":false,
            "x-queryable":true
        },
        "GroupDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the page group.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column:The date and time when the row for the identifier was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "pageGroupMembers":{
            "title":"Page Group Members",
            "type":"array",
            "description":"The page group members resource is used to view, create, or modify the memberships of page groups.",
            "items":{
                "$ref":"#/components/schemas/hedPageGroups-pageGroupMembers-item-response"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Who column: The user who first created the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Identifies the row as seed data of the page group.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"1",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GroupId":{
            "type":"integer",
            "description":"Unique identifier of the page group.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: The date and time when the row for the identifier was 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 : Page Group Members

Type: array

Title: Page Group Members

The page group members resource is used to view, create, or modify the memberships of page groups.

Show Source

• Array of: object hedPageGroups-pageGroupMembers-item-response

{
    "title":"Page Group Members",
    "type":"array",
    "description":"The page group members resource is used to view, create, or modify the memberships of page groups.",
    "items":{
        "$ref":"#/components/schemas/hedPageGroups-pageGroupMembers-item-response"
    }
}

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

Nested Schema : hedPageGroups-pageGroupMembers-item-response

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Who column: The date and time when the row for the identifier was created.
• FunctionalAreaCode: string
  Title: Functional Area Code

  Read Only: true

  Maximum Length: 30

  Identifies the functional area code of the page group.
• FunctionalAreaMeaning: string
  Title: Functional Area

  Read Only: true

  Maximum Length: 80

  Identifies the functional area of the page group.
• GroupMemberId: integer (int64)
  Read Only: true

  Unique identifier of the page group member.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  Who column: The date and time when the row for the identifier was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  Who column: The user who last updated the row for the identifier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PageCode: string
  Read Only: true

  Maximum Length: 100

  A code that identifies the page group member.
• PageDescription: string
  Read Only: true

  Maximum Length: 1000

  Description of the page group member.
• PageId: integer (int64)
  Unique identifier of the page.
• PageName: string
  Maximum Length: 100

  Name of the page group member.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Who column: The user who last updated the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PageId":{
            "type":"integer",
            "description":"Unique identifier of the page.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PageCode":{
            "maxLength":"100",
            "type":"string",
            "description":"A code that identifies the page group member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: The date and time when the row for the identifier was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalAreaCode":{
            "title":"Functional Area Code",
            "maxLength":"30",
            "type":"string",
            "description":"Identifies the functional area code of the page group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Who column: The user who first created the row for the identifier.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FunctionalAreaMeaning":{
            "title":"Functional Area",
            "maxLength":"80",
            "type":"string",
            "description":"Identifies the functional area of the page group.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupMemberId":{
            "type":"integer",
            "description":"Unique identifier of the page group member.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PageDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the page group member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PageName":{
            "maxLength":"100",
            "type":"string",
            "description":"Name of the page group member.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Who column: The date and time when the row for the identifier was 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"
    }
}

Links

pageGroupMembers

Operation: /fscmRestApi/resources/11.13.18.05/hedPageGroups/{GroupId}/child/pageGroupMembers

Parameters:

• GroupId: $request.path.GroupId

The page group members resource is used to view, create, or modify the memberships of page groups.

Back to Top