Jump to

• Request
• Response

Update a resource group

patch

/fscmRestApi/resources/11.13.18.05/productionSchedulingOrganizations/{OrganizationId}/child/resourceGroups/{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=
• OrganizationId(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

• Description: string
  Maximum Length: 2000

  Description of the associated attribute.
• GroupCode(required): string
  Maximum Length: 300

  Abbreviation that identifies the resource group.
• GroupId: integer (int64)
  Value that uniquely identifies the resource group used in the changeover. It's a primary key of the resource group.
• groupMembers: array Group Members
  Title: Group Members

  The Group Members resource associates a resource to a resource group.
• IncludeOSPSupplierFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the outside processing supplier is added to the resource group. If false, the outside processing supplier isn't added to the resource group. The default value is false.
• OrganizationId(required): integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.

{
    "required":[
        "GroupCode",
        "OrganizationId"
    ],
    "type":"object",
    "properties":{
        "groupMembers":{
            "title":"Group Members",
            "type":"array",
            "description":"The Group Members resource associates a resource to a resource group.",
            "items":{
                "$ref":"#/components/schemas/productionSchedulingOrganizations-resourceGroups-groupMembers-item-patch-request"
            }
        },
        "GroupCode":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that identifies the resource group.",
            "nullable":false
        },
        "IncludeOSPSupplierFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the outside processing supplier is added to the resource group. If false, the outside processing supplier isn't added to the resource group. The default value is false.",
            "nullable":true
        },
        "Description":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the associated attribute.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource group used in the changeover. It's a primary key of the resource group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        }
    }
}

Nested Schema : Group Members

Type: array

Title: Group Members

The Group Members resource associates a resource to a resource group.

Show Source

• Array of: object schema

{
    "title":"Group Members",
    "type":"array",
    "description":"The Group Members resource associates a resource to a resource group.",
    "items":{
        "$ref":"#/components/schemas/productionSchedulingOrganizations-resourceGroups-groupMembers-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• GroupId: integer (int64)
  Value that uniquely identifies the resource group used in the changeover. It's a primary key of the resource group.
• MemberId: integer (int64)
  Value that uniquely identifies the group member. It's a primary key of the group member.
• MemberSequenceNumber: number
  Number that indicates the ordering sequence of members into a group with custom order. This attribute is NULL for all members in a group with default alphanumeric order.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
• ResourceCode: string
  Maximum Length: 300

  Abbreviation that identifies the production resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.
• ResourceName: string
  Maximum Length: 120

  Name of the resource used to define the resource associated with a group.
• WorkCenterCode: string
  Maximum Length: 100

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center for the resource that's used in the changeover. It's a primary key of the work center.
• WorkCenterName: string
  Maximum Length: 120

  Name of the work center used to define the resource associated with a group.

{
    "type":"object",
    "properties":{
        "MemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group member. It's a primary key of the group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ResourceCode":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":true
        },
        "WorkCenterName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center used to define the resource associated with a group.",
            "nullable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center for the resource that's used in the changeover. It's a primary key of the work center.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResourceName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the resource used to define the resource associated with a group.",
            "nullable":true
        },
        "MemberSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the ordering sequence of members into a group with custom order. This attribute is NULL for all members in a group with default alphanumeric order.",
            "nullable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "WorkCenterCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource group used in the changeover. It's a primary key of the resource group.",
            "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 : productionSchedulingOrganizations-resourceGroups-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• Description: string
  Maximum Length: 2000

  Description of the associated attribute.
• GroupCode: string
  Maximum Length: 300

  Abbreviation that identifies the resource group.
• GroupId: integer (int64)
  Value that uniquely identifies the resource group used in the changeover. It's a primary key of the resource group.
• groupMembers: array Group Members
  Title: Group Members

  The Group Members resource associates a resource to a resource group.
• IncludeOSPSupplierFlag: boolean
  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the outside processing supplier is added to the resource group. If false, the outside processing supplier isn't added to the resource group. The default value is false.
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "groupMembers":{
            "title":"Group Members",
            "type":"array",
            "description":"The Group Members resource associates a resource to a resource group.",
            "items":{
                "$ref":"#/components/schemas/productionSchedulingOrganizations-resourceGroups-groupMembers-item-response"
            }
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the associated attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "GroupCode":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that identifies the resource group.",
            "nullable":false,
            "x-queryable":true
        },
        "IncludeOSPSupplierFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the outside processing supplier is added to the resource group. If false, the outside processing supplier isn't added to the resource group. The default value is false.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource group used in the changeover. It's a primary key of the resource group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Group Members

Type: array

Title: Group Members

The Group Members resource associates a resource to a resource group.

Show Source

• Array of: object productionSchedulingOrganizations-resourceGroups-groupMembers-item-response

{
    "title":"Group Members",
    "type":"array",
    "description":"The Group Members resource associates a resource to a resource group.",
    "items":{
        "$ref":"#/components/schemas/productionSchedulingOrganizations-resourceGroups-groupMembers-item-response"
    }
}

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 : productionSchedulingOrganizations-resourceGroups-groupMembers-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Read Only: true
• GroupId: integer (int64)
  Value that uniquely identifies the resource group used in the changeover. It's a primary key of the resource group.
• LastUpdateDate: string (date-time)
  Read Only: true
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberId: integer (int64)
  Value that uniquely identifies the group member. It's a primary key of the group member.
• MemberSequenceNumber: number
  Number that indicates the ordering sequence of members into a group with custom order. This attribute is NULL for all members in a group with default alphanumeric order.
• OrganizationId: integer (int64)
  Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.
• ResourceCode: string
  Maximum Length: 300

  Abbreviation that identifies the production resource.
• ResourceId: integer (int64)
  Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.
• ResourceName: string
  Maximum Length: 120

  Name of the resource used to define the resource associated with a group.
• WorkCenterCode: string
  Maximum Length: 100

  Abbreviation that identifies the work center.
• WorkCenterId: integer (int64)
  Value that uniquely identifies the work center for the resource that's used in the changeover. It's a primary key of the work center.
• WorkCenterName: string
  Maximum Length: 120

  Name of the work center used to define the resource associated with a group.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceCode":{
            "maxLength":"300",
            "type":"string",
            "description":"Abbreviation that identifies the production resource.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work center used to define the resource associated with a group.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkCenterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work center for the resource that's used in the changeover. It's a primary key of the work center.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "maxLength":"120",
            "type":"string",
            "description":"Name of the resource used to define the resource associated with a group.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the inventory organization that's enabled for scheduling. It's a primary key of the inventory organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource group used in the changeover. It's a primary key of the resource group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MemberId":{
            "type":"integer",
            "description":"Value that uniquely identifies the group member. It's a primary key of the group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "description":"Value that uniquely identifies the resource that's used in the changeover. It's a primary key of the resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "MemberSequenceNumber":{
            "type":"number",
            "description":"Number that indicates the ordering sequence of members into a group with custom order. This attribute is NULL for all members in a group with default alphanumeric order.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkCenterCode":{
            "maxLength":"100",
            "type":"string",
            "description":"Abbreviation that identifies the work center.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "nullable":true,
            "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."
        }
    }
}

Links

groupMembers

Operation: /fscmRestApi/resources/11.13.18.05/productionSchedulingOrganizations/{OrganizationId}/child/resourceGroups/{GroupId}/child/groupMembers

Parameters:

• GroupId: $request.path.GroupId
• OrganizationId: $request.path.OrganizationId

The Group Members resource associates a resource to a resource group.

Back to Top