Jump to

• Request
• Response

Update a job group definition

patch

/fscmRestApi/resources/11.13.18.05/publicSectorJobGroupDefinitions/{publicSectorJobGroupDefinitionsUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorJobGroupDefinitionsUniqID: integer
  This is the hash key of the attributes which make up the composite key--- AgencyId and JobFuncGrpId ---for the Job Group Definitions resource and used to uniquely identify an instance of Job Group Definitions. The client should not generate the hash key value. Instead, the client should query on the Job Group Definitions collection resource with a filter on the primary key values in order to navigate to a specific instance of Job Group Definitions.
  
  For example: publicSectorJobGroupDefinitions?q=AgencyId=<value1>;JobFuncGrpId=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorJobGroupDefinitions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates if the job group definition is availabe to be used.
• JobFuncGrpId(optional): string
  Title: Job Group ID

  Maximum Length: 50

  The unique identifier of the job group definition.
• JobGroupDescription(optional): string
  Title: Job Group

  Maximum Length: 100

  The description of the job group.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the job group definition is availabe to be used.",
            "title":"Enabled"
        },
        "JobFuncGrpId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the job group definition.",
            "title":"Job Group ID"
        },
        "JobGroupDescription":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the job group.",
            "title":"Job Group"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorJobGroupDefinitions-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The identifier of the public sector agency.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date and time when the row was created.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates if the job group definition is availabe to be used.
• JobFuncGrpId(optional): string
  Title: Job Group ID

  Maximum Length: 50

  The unique identifier of the job group definition.
• JobGroupDescription(optional): string
  Title: Job Group

  Maximum Length: 100

  The description of the job group.
• LastUpdateDate(optional): string(date-time)
  Title: Last Updated Date

  The date and time when the row was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The name of the user who last updated the row.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was created.",
            "title":"Creation Date"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the job group definition is availabe to be used.",
            "title":"Enabled"
        },
        "JobFuncGrpId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the job group definition.",
            "title":"Job Group ID"
        },
        "JobGroupDescription":{
            "maxLength":100,
            "type":"string",
            "description":"The description of the job group.",
            "title":"Job Group"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "title":"Last Updated By"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top