Jump to

• Request
• Response

Create a mapping

post

/crmRestApi/resources/11.13.18.05/cssIdpRoleMappings

Request

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

• CssRoleCd: string
  Title: Self-Service Role Code

  Maximum Length: 30

  The unique identifier of the self-service role.
• IdpRoleCode: string
  Title: Identity Provider Role Code

  Maximum Length: 240

  The unique identifier of the job role.

{
    "type":"object",
    "properties":{
        "IdpRoleCode":{
            "title":"Identity Provider Role Code",
            "maxLength":"240",
            "type":"string",
            "description":"The unique identifier of the job role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CssRoleCd":{
            "title":"Self-Service Role Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the self-service role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

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

Type: object

Show Source

• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the role mapping.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the role mapping record was created.
• CssRoleCd: string
  Title: Self-Service Role Code

  Maximum Length: 30

  The unique identifier of the self-service role.
• CssRoleName: string
  Title: Self-Service Role

  Read Only: true

  Maximum Length: 80

  The name of the self-service role.
• IdpRoleCode: string
  Title: Identity Provider Role Code

  Maximum Length: 240

  The unique identifier of the job role.
• IdpRoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 240

  The name of the job role.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the role mapping record was updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who updated the role mapping.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The user who updated the role mapping.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RoleMappingId: integer (int64)
  Title: Role Mapping ID

  Read Only: true

  The unique identifier of the role mapping.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who updated the role mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the role mapping record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the role mapping.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CssRoleCd":{
            "title":"Self-Service Role Code",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the self-service role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RoleMappingId":{
            "title":"Role Mapping ID",
            "type":"integer",
            "description":"The unique identifier of the role mapping.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IdpRoleName":{
            "title":"Role Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the job role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CssRoleName":{
            "title":"Self-Service Role",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the self-service role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IdpRoleCode":{
            "title":"Identity Provider Role Code",
            "maxLength":"240",
            "type":"string",
            "description":"The unique identifier of the job role.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the role mapping record was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The user who updated the role mapping.",
            "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

CssRoleLookupVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_SVC_CSS_REL_TYPE_CD

The list of values indicating the custom self-service roles.

The following properties are defined on the LOV link relation:

• Source Attribute: CssRoleCd; Target Attribute: LookupCode
• Display Attribute: Meaning

RolePVO

Operation: /hcmRestApi/resources/11.13.18.05/rolesLOV

The list of values indicating the job roles.

The following properties are defined on the LOV link relation:

• Source Attribute: IdpRoleCode; Target Attribute: RoleCommonName
• Display Attribute: RoleName

Back to Top