Jump to

• Request
• Response
• Examples

Create or replace a work skill group

put

/rest/ofscMetadata/v1/workSkillGroups/{label}

This operation creates a work skill group resource or updates an existing one.

If the 'translation' parameter is not available for the update, then the translations are not changed; else all the translations are replaced by the structure from the request. The translations that are sent as entity fields are ignored.

Request

Path Parameters

• label(required): string
  Minimum Length: 1

  Maximum Length: 40

  The label of the work skill group.

Body ()

This section describes the request body parameters for this operation.

Root Schema : Work Skill Group

Type: object

Title: Work Skill Group

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

  If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true.

  Note: It is present for all work skill groups.

• addToCapacityCategory(required): boolean
  Title: Add to Capacity Category

  Contains one of the following values: true or false.

  If true, then the work skill group is added to the capacity category. By default, it is true.

  Note: This field is present for all work skill groups.

• assignToResource(required): boolean
  Title: Assign to Resource

  Contains one of the following values: true or false.

  If true, then the work skill group is assigned to the resource. By default, it is true.

  Note: This field is present for all work skill groups.

• label: string
  Title: Label

  Minimum Length: 1

  Maximum Length: 40

  The label of the work skill group.
• name: string
  Title: Name

  Minimum Length: 1

  Maximum Length: 5000

  The name of the work skill group in the user's language.
• translations(required): array Translations
  Title: Translations

  The array of translation objects associated with the work skill group.
• workSkills: array Work Skills
  Title: Work Skills

  The array of work skill objects associated with the work skill group.

{
    "type":"object",
    "title":"Work Skill Group",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":40,
            "title":"Label",
            "description":"The label of the work skill group."
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":5000,
            "title":"Name",
            "description":"The name of the work skill group in the user's language. "
        },
        "assignToResource":{
            "type":"boolean",
            "title":"Assign to Resource",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is assigned to the resource. By default, it is true. </p><p><b>Note: </b>This field is present for all work skill groups.</p>"
        },
        "addToCapacityCategory":{
            "type":"boolean",
            "title":"Add to Capacity Category",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is added to the capacity category. By default, it is true. </p><p><b>Note: </b>This field is present for all work skill groups.</p>"
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true. </p><p><b>Note: </b>It is present for all work skill groups.</p>"
        },
        "workSkills":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the work skill object.",
                        "type":"string"
                    },
                    "ratio":{
                        "description":"The ratio used to assign the work skill group to a resource.",
                        "type":"integer",
                        "maximum":100,
                        "minimum":1
                    }
                },
                "required":[
                    "label",
                    "ratio"
                ]
            },
            "title":"Work Skills",
            "description":"The array of work skill objects associated with the work skill group."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The array of translation objects associated with the work skill group."
        }
    },
    "required":[
        "assignToResource",
        "addToCapacityCategory",
        "active",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The array of translation objects associated with the work skill group.

Show Source

• Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The array of translation objects associated with the work skill group."
}

Nested Schema : Work Skills

Type: array

Title: Work Skills

The array of work skill objects associated with the work skill group.

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the work skill object.",
                "type":"string"
            },
            "ratio":{
                "description":"The ratio used to assign the work skill group to a resource.",
                "type":"integer",
                "maximum":100,
                "minimum":1
            }
        },
        "required":[
            "label",
            "ratio"
        ]
    },
    "title":"Work Skills",
    "description":"The array of work skill objects associated with the work skill group."
}

Nested Schema : Translation

Type: object

Show Source

• language(required): string
  This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.
• languageISO: string
  This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)
• name(required): string

{
    "properties":{
        "language":{
            "description":"This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.",
            "type":"string"
        },
        "languageISO":{
            "description":"This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)",
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Nested Schema : items

Type: object

Show Source

• label(required): string
  The label of the work skill object.
• ratio(required): integer
  Minimum Value: 1

  Maximum Value: 100

  The ratio used to assign the work skill group to a resource.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the work skill object.",
            "type":"string"
        },
        "ratio":{
            "description":"The ratio used to assign the work skill group to a resource.",
            "type":"integer",
            "maximum":100,
            "minimum":1
        }
    },
    "required":[
        "label",
        "ratio"
    ]
}

Back to Top

Response

Supported Media Types

• application/schema+json
• application/json

200 Response

This section describes the 200 status response for this operation. This code is returned when a work skill group object is updated.

Body ()

Root Schema : Work Skill Group

Type: object

Title: Work Skill Group

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

  If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true.

  Note: It is present for all work skill groups.

• addToCapacityCategory(required): boolean
  Title: Add to Capacity Category

  Contains one of the following values: true or false.

  If true, then the work skill group is added to the capacity category. By default, it is true.

  Note: This field is present for all work skill groups.

• assignToResource(required): boolean
  Title: Assign to Resource

  Contains one of the following values: true or false.

  If true, then the work skill group is assigned to the resource. By default, it is true.

  Note: This field is present for all work skill groups.

• label: string
  Title: Label

  Minimum Length: 1

  Maximum Length: 40

  The label of the work skill group.
• name: string
  Title: Name

  Minimum Length: 1

  Maximum Length: 5000

  The name of the work skill group in the user's language.
• translations(required): array Translations
  Title: Translations

  The array of translation objects associated with the work skill group.
• workSkills: array Work Skills
  Title: Work Skills

  The array of work skill objects associated with the work skill group.

{
    "type":"object",
    "title":"Work Skill Group",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":40,
            "title":"Label",
            "description":"The label of the work skill group."
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":5000,
            "title":"Name",
            "description":"The name of the work skill group in the user's language. "
        },
        "assignToResource":{
            "type":"boolean",
            "title":"Assign to Resource",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is assigned to the resource. By default, it is true. </p><p><b>Note: </b>This field is present for all work skill groups.</p>"
        },
        "addToCapacityCategory":{
            "type":"boolean",
            "title":"Add to Capacity Category",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is added to the capacity category. By default, it is true. </p><p><b>Note: </b>This field is present for all work skill groups.</p>"
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true. </p><p><b>Note: </b>It is present for all work skill groups.</p>"
        },
        "workSkills":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the work skill object.",
                        "type":"string"
                    },
                    "ratio":{
                        "description":"The ratio used to assign the work skill group to a resource.",
                        "type":"integer",
                        "maximum":100,
                        "minimum":1
                    }
                },
                "required":[
                    "label",
                    "ratio"
                ]
            },
            "title":"Work Skills",
            "description":"The array of work skill objects associated with the work skill group."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The array of translation objects associated with the work skill group."
        }
    },
    "required":[
        "assignToResource",
        "addToCapacityCategory",
        "active",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The array of translation objects associated with the work skill group.

Show Source

• Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The array of translation objects associated with the work skill group."
}

Nested Schema : Work Skills

Type: array

Title: Work Skills

The array of work skill objects associated with the work skill group.

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the work skill object.",
                "type":"string"
            },
            "ratio":{
                "description":"The ratio used to assign the work skill group to a resource.",
                "type":"integer",
                "maximum":100,
                "minimum":1
            }
        },
        "required":[
            "label",
            "ratio"
        ]
    },
    "title":"Work Skills",
    "description":"The array of work skill objects associated with the work skill group."
}

Nested Schema : Translation

Type: object

Show Source

• language(required): string
  This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.
• languageISO: string
  This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)
• name(required): string

{
    "properties":{
        "language":{
            "description":"This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.",
            "type":"string"
        },
        "languageISO":{
            "description":"This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)",
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Nested Schema : items

Type: object

Show Source

• label(required): string
  The label of the work skill object.
• ratio(required): integer
  Minimum Value: 1

  Maximum Value: 100

  The ratio used to assign the work skill group to a resource.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the work skill object.",
            "type":"string"
        },
        "ratio":{
            "description":"The ratio used to assign the work skill group to a resource.",
            "type":"integer",
            "maximum":100,
            "minimum":1
        }
    },
    "required":[
        "label",
        "ratio"
    ]
}

201 Response

This section describes the 201 status response for this operation. This code is returned when a work skill group object is created.

Body ()

Root Schema : Work Skill Group

Type: object

Title: Work Skill Group

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

  If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true.

  Note: It is present for all work skill groups.

• addToCapacityCategory(required): boolean
  Title: Add to Capacity Category

  Contains one of the following values: true or false.

  If true, then the work skill group is added to the capacity category. By default, it is true.

  Note: This field is present for all work skill groups.

• assignToResource(required): boolean
  Title: Assign to Resource

  Contains one of the following values: true or false.

  If true, then the work skill group is assigned to the resource. By default, it is true.

  Note: This field is present for all work skill groups.

• label: string
  Title: Label

  Minimum Length: 1

  Maximum Length: 40

  The label of the work skill group.
• name: string
  Title: Name

  Minimum Length: 1

  Maximum Length: 5000

  The name of the work skill group in the user's language.
• translations(required): array Translations
  Title: Translations

  The array of translation objects associated with the work skill group.
• workSkills: array Work Skills
  Title: Work Skills

  The array of work skill objects associated with the work skill group.

{
    "type":"object",
    "title":"Work Skill Group",
    "properties":{
        "label":{
            "type":"string",
            "minLength":1,
            "maxLength":40,
            "title":"Label",
            "description":"The label of the work skill group."
        },
        "name":{
            "type":"string",
            "minLength":1,
            "maxLength":5000,
            "title":"Name",
            "description":"The name of the work skill group in the user's language. "
        },
        "assignToResource":{
            "type":"boolean",
            "title":"Assign to Resource",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is assigned to the resource. By default, it is true. </p><p><b>Note: </b>This field is present for all work skill groups.</p>"
        },
        "addToCapacityCategory":{
            "type":"boolean",
            "title":"Add to Capacity Category",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is added to the capacity category. By default, it is true. </p><p><b>Note: </b>This field is present for all work skill groups.</p>"
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"<p>Contains one of the following values: true or false.</p><p>If true, then the work skill group is active. If false, then the work skill group is inactive. By default, it is true. </p><p><b>Note: </b>It is present for all work skill groups.</p>"
        },
        "workSkills":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "label":{
                        "description":"The label of the work skill object.",
                        "type":"string"
                    },
                    "ratio":{
                        "description":"The ratio used to assign the work skill group to a resource.",
                        "type":"integer",
                        "maximum":100,
                        "minimum":1
                    }
                },
                "required":[
                    "label",
                    "ratio"
                ]
            },
            "title":"Work Skills",
            "description":"The array of work skill objects associated with the work skill group."
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The array of translation objects associated with the work skill group."
        }
    },
    "required":[
        "assignToResource",
        "addToCapacityCategory",
        "active",
        "translations"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The array of translation objects associated with the work skill group.

Show Source

• Array of: object Translation

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Translation"
    },
    "title":"Translations",
    "description":"The array of translation objects associated with the work skill group."
}

Nested Schema : Work Skills

Type: array

Title: Work Skills

The array of work skill objects associated with the work skill group.

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "label":{
                "description":"The label of the work skill object.",
                "type":"string"
            },
            "ratio":{
                "description":"The ratio used to assign the work skill group to a resource.",
                "type":"integer",
                "maximum":100,
                "minimum":1
            }
        },
        "required":[
            "label",
            "ratio"
        ]
    },
    "title":"Work Skills",
    "description":"The array of work skill objects associated with the work skill group."
}

Nested Schema : Translation

Type: object

Show Source

• language(required): string
  This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.
• languageISO: string
  This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)
• name(required): string

{
    "properties":{
        "language":{
            "description":"This field contains language code of a text translation, it conatains two characters length code in responses (e.g. 'en', 'es') but can be used in requests as extended ISO code (e.g. 'en-US') as well as old two character format.",
            "type":"string"
        },
        "languageISO":{
            "description":"This field is used only in responses and returns ISO language code (e.g. 'en-US'). This field is ignored in the requests (use 'language' instead)",
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    },
    "required":[
        "language",
        "name"
    ]
}

Nested Schema : items

Type: object

Show Source

• label(required): string
  The label of the work skill object.
• ratio(required): integer
  Minimum Value: 1

  Maximum Value: 100

  The ratio used to assign the work skill group to a resource.

{
    "type":"object",
    "properties":{
        "label":{
            "description":"The label of the work skill object.",
            "type":"string"
        },
        "ratio":{
            "description":"The ratio used to assign the work skill group to a resource.",
            "type":"integer",
            "maximum":100,
            "minimum":1
        }
    },
    "required":[
        "label",
        "ratio"
    ]
}

Default Response

This section describes the default error response for this operation.

Body ()

Root Schema : Error

Type: object

Show Source

• detail: string
  The detailed description of this error.
• status: string
  The HTTP status code of this error.
• title(required): string
  The brief description of this error.
• type(required): string
  The URL of the web page containing more details about this error.

{
    "properties":{
        "type":{
            "type":"string",
            "description":"The URL of the web page containing more details about this error."
        },
        "title":{
            "type":"string",
            "description":"The brief description of this error."
        },
        "status":{
            "type":"string",
            "description":"The HTTP status code of this error."
        },
        "detail":{
            "type":"string",
            "description":"The detailed description of this error."
        }
    },
    "required":[
        "type",
        "title"
    ]
}

Back to Top

Examples

The following example shows how to create or replace a work skill group by submitting a PUT request on the REST resource.

Example of Request Header

The following shows an example of the request header.

PUT /rest/ofscMetadata/v1/workSkillGroups/new_ws_group HTTP/1.0
Host: <instance_name>.fs.ocs.oraclecloud.com 
Authorization: Basic c29hcEBwZXRyb2xpYXNoZXZ5Y2gucmVzdDox 
Accept: */*
Content-Length: 228

Example of Request Body

The following example shows the contents of the request body in JSON format.

{  
    "active":true,
    "assignToResource":true,
    "addToCapacityCategory":false,
    "translations":[
        {  
            "language":"en",  
            "name":"New work skill group"
        }
    ],
    "workSkills":[  
        {  
            "label":"NP",
            "ratio":100
        }
    ]
}

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 201 Created
Server: nginx/1.6.2
Date: Fri, 24 Jul 2015 08:54:08 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive

Example of Response Body

The following example shows the contents of the response body in JSON format.

{ 
    "label":"new_ws_group",
    "name":"New work skill group",
    "active":true,
    "assignToResource":true,
    "addToCapacityCategory":false,
    "translations":[
        { 
            "language":"en", 
            "name":"New work skill group"
        }
    ],
    "workSkills":[ 
        { 
            "label":"NP",
            "ratio":100
        }
    ],
    "links":[ 
        { 
            "rel":"canonical",
            "href":"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workSkillGroups/new_ws_group"
        },
        { 
            "rel":"describedby",
            "href":"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workSkillGroups"
        }
    ]
}

Back to Top