Jump to

• Request
• Response
• Examples

Create or replace a work skill

put

/rest/ofscMetadata/v1/workSkills/{label}

This operation creates a work skill or replaces an existing work skill.

Request

Path Parameters

• label(required): string
  Minimum Length: 1

  Maximum Length: 40

  The label of the work skill.

Body ()

The work skill object that needs to be created or updated.

Root Schema : Work Skills

Type: object

Title: Work Skills

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

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

• label: string
  Title: Label

  Minimum Length: 1

  Maximum Length: 40

  The label of the work skill specified in the request.
• name: string
  Title: Name

  The name of the work skill in user's language.
• sharing(required): string
  Title: Sharing

  Allowed Values: [ "no sharing", "maximal", "minimal", "summary" ]

  The sharing option defined for work skills in the team.

  The allowed values are as follows:

  • Maximal: The team gets the maximum work skill level of all team members. This is the default value.
  • Minimal: The team gets the minimal work skill level of all team members.
  • No sharing: The team does not get the work skill of a team member.
  • Summary: The team gets the total sum of work skill levels of all the team members.
• translations: array Translations
  Title: Translations

  The list of translations associated with the name of the work skill.

{
    "type":"object",
    "title":"Work Skills",
    "properties":{
        "label":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "title":"Label",
            "description":"The label of the work skill specified in the request."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The name of the work skill in user's language."
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<p>If true, then the work skill is active. If false, then the work skill is inactive. By default, it is true."
        },
        "sharing":{
            "type":"string",
            "enum":[
                "no sharing",
                "maximal",
                "minimal",
                "summary"
            ],
            "title":"Sharing",
            "description":"The sharing option defined for work skills in the team. <p>The allowed values are as follows:</p><ul><li>Maximal: The team gets the maximum work skill level of all team members. This is the default value.</li><li>Minimal: The team gets the minimal work skill level of all team members.</li><li>No sharing: The team does not get the work skill of a team member.</li><li>Summary: The team gets the total sum of work skill levels of all the team members.</li></ul>"
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The list of translations associated with the name of the work skill."
        }
    },
    "required":[
        "active",
        "sharing"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The list of translations associated with the name of the work skill.

Show Source

• Array of: object Translation

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

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

Back to Top

Response

Supported Media Types

• application/json
• application/schema+json

200 Response

This section describes the 200 status response for this operation.

Body ()

Root Schema : Work Skills

Type: object

Title: Work Skills

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

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

• label: string
  Title: Label

  Minimum Length: 1

  Maximum Length: 40

  The label of the work skill specified in the request.
• name: string
  Title: Name

  The name of the work skill in user's language.
• sharing(required): string
  Title: Sharing

  Allowed Values: [ "no sharing", "maximal", "minimal", "summary" ]

  The sharing option defined for work skills in the team.

  The allowed values are as follows:

  • Maximal: The team gets the maximum work skill level of all team members. This is the default value.
  • Minimal: The team gets the minimal work skill level of all team members.
  • No sharing: The team does not get the work skill of a team member.
  • Summary: The team gets the total sum of work skill levels of all the team members.
• translations: array Translations
  Title: Translations

  The list of translations associated with the name of the work skill.

{
    "type":"object",
    "title":"Work Skills",
    "properties":{
        "label":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "title":"Label",
            "description":"The label of the work skill specified in the request."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The name of the work skill in user's language."
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<p>If true, then the work skill is active. If false, then the work skill is inactive. By default, it is true."
        },
        "sharing":{
            "type":"string",
            "enum":[
                "no sharing",
                "maximal",
                "minimal",
                "summary"
            ],
            "title":"Sharing",
            "description":"The sharing option defined for work skills in the team. <p>The allowed values are as follows:</p><ul><li>Maximal: The team gets the maximum work skill level of all team members. This is the default value.</li><li>Minimal: The team gets the minimal work skill level of all team members.</li><li>No sharing: The team does not get the work skill of a team member.</li><li>Summary: The team gets the total sum of work skill levels of all the team members.</li></ul>"
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The list of translations associated with the name of the work skill."
        }
    },
    "required":[
        "active",
        "sharing"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The list of translations associated with the name of the work skill.

Show Source

• Array of: object Translation

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

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

201 Response

This section describes the 201 status response for this operation.

Body ()

Root Schema : Work Skills

Type: object

Title: Work Skills

Show Source

• active(required): boolean
  Title: Active

  Contains one of the following values: true or false.

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

• label: string
  Title: Label

  Minimum Length: 1

  Maximum Length: 40

  The label of the work skill specified in the request.
• name: string
  Title: Name

  The name of the work skill in user's language.
• sharing(required): string
  Title: Sharing

  Allowed Values: [ "no sharing", "maximal", "minimal", "summary" ]

  The sharing option defined for work skills in the team.

  The allowed values are as follows:

  • Maximal: The team gets the maximum work skill level of all team members. This is the default value.
  • Minimal: The team gets the minimal work skill level of all team members.
  • No sharing: The team does not get the work skill of a team member.
  • Summary: The team gets the total sum of work skill levels of all the team members.
• translations: array Translations
  Title: Translations

  The list of translations associated with the name of the work skill.

{
    "type":"object",
    "title":"Work Skills",
    "properties":{
        "label":{
            "type":"string",
            "minLength":"1",
            "maxLength":"40",
            "title":"Label",
            "description":"The label of the work skill specified in the request."
        },
        "name":{
            "type":"string",
            "title":"Name",
            "description":"The name of the work skill in user's language."
        },
        "active":{
            "type":"boolean",
            "title":"Active",
            "description":"Contains one of the following values: true or false.<p>If true, then the work skill is active. If false, then the work skill is inactive. By default, it is true."
        },
        "sharing":{
            "type":"string",
            "enum":[
                "no sharing",
                "maximal",
                "minimal",
                "summary"
            ],
            "title":"Sharing",
            "description":"The sharing option defined for work skills in the team. <p>The allowed values are as follows:</p><ul><li>Maximal: The team gets the maximum work skill level of all team members. This is the default value.</li><li>Minimal: The team gets the minimal work skill level of all team members.</li><li>No sharing: The team does not get the work skill of a team member.</li><li>Summary: The team gets the total sum of work skill levels of all the team members.</li></ul>"
        },
        "translations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Translation"
            },
            "title":"Translations",
            "description":"The list of translations associated with the name of the work skill."
        }
    },
    "required":[
        "active",
        "sharing"
    ]
}

Nested Schema : Translations

Type: array

Title: Translations

The list of translations associated with the name of the work skill.

Show Source

• Array of: object Translation

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

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

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 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/workSkills/NP 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,
    "sharing":"maximal",
    "translations":
    [
        {
            "language":"en",  
            "name":"Non-Pay"
        }
    ]
}

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":"NP",
    "name":"Non-Pay",
    "active":true,
    "sharing":"maximal",
    "translations":[
        {
 
            "language":"en", 
            "name":"Non-Pay"
        }
    ]
    },
    "links":[ 
        { 
            "rel":"canonical",
            "href":"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workSkills/NP"
        },
        {
            "rel": "workSkillConditions",
            "href": "http://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/workSkills/NP/workSkillConditions"
        },
        { 
            "rel":"describedby",
            "href":"https://<instance_name>.fs.ocs.oraclecloud.com/rest/ofscMetadata/v1/metadata-catalog/workSkills"
        }
    ]
 }

Back to Top