REST API for Oracle Supply Chain Management Cloud

Create user statuses

post

/fscmRestApi/resources/11.13.18.05/channelUserStatuses

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.
Upsert-Mode:

Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

BuySideFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the user status is enabled for the buy-side flows. If false, then the user status is not enabled for the buy-side flows. This attribute does not have a default value.
DefaultFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then for the given system status and user status for combination, the selected user status will be set as default for the buy side. If false, then do not set the user status as the default status. This attribute does not have a default value.
Description: string

Maximum Length: 1000

Description of the channel user status.
EnabledFlag: boolean

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then the user status is enabled for the system status. If false, then the user status is not enabled. This attribute does not have a default value.
SeededFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the status is predefined. If false, then the status is not predefined. This attribute does not have a default value.
SellSideDefaultFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then for the given system status and user status for combination, the selected user status will be set as default for the sell side. If false, then do not set the user status as the default status. This attribute does not have a default value.
SellSideFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the user status is enabled for the sell-side flows. If false, then the user status is not enabled for the sell-side flows. This attribute does not have a default value.
SystemStatus: string

Name of the system status of the channel objects. Based on the value selected in UserStatusFor, values from the lookup type ORA_CJM_PROGRAM_TYPE_STATUS, ORA_CJM_PROGRAM_STATUS, or ORA_CJM_CLAIM_STATUS can be passed.
SystemStatusCode: string

Maximum Length: 30

Abbreviation that identifies the system status of the channel objects.
UserStatusCode: string

Maximum Length: 30

Abbreviation that identifies the channel user status.
UserStatusFor: string

Name of the channel object type for which the user status is created. A list of accepted values is defined in the lookup type ORA_CJM_USER_STATUS_FOR.
UserStatusForCode: string

Maximum Length: 30

Abbreviation that identifies the channel object type for which the user status is created. A list of accepted values is defined in the lookup type ORA_CJM_USER_STATUS_FOR.
UserStatusName: string

Maximum Length: 50

Name of the channel user status.

{
    "type":"object",
    "properties":{
        "SystemStatus":{
            "type":"string",
            "description":"Name of the system status of the channel objects. Based on the value selected in UserStatusFor, values from the lookup type ORA_CJM_PROGRAM_TYPE_STATUS, ORA_CJM_PROGRAM_STATUS, or ORA_CJM_CLAIM_STATUS can be passed.",
            "nullable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the channel user status.",
            "nullable":true,
            "x-queryable":false
        },
        "UserStatusForCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the channel object type for which the user status is created. A list of accepted values is defined in the lookup type ORA_CJM_USER_STATUS_FOR.",
            "nullable":false
        },
        "UserStatusFor":{
            "type":"string",
            "description":"Name of the channel object type for which the user status is created. A list of accepted values is defined in the lookup type ORA_CJM_USER_STATUS_FOR.",
            "nullable":true
        },
        "SystemStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the system status of the channel objects.",
            "nullable":false
        },
        "SellSideFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the user status is enabled for the sell-side flows. If false, then the user status is not enabled for the sell-side flows. This attribute does not have a default value.",
            "nullable":true,
            "default":false
        },
        "UserStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the channel user status.",
            "nullable":false
        },
        "UserStatusName":{
            "maxLength":"50",
            "type":"string",
            "description":"Name of the channel user status.",
            "nullable":false
        },
        "SeededFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the status is predefined. If false, then the status is not predefined. This attribute does not have a default value.",
            "nullable":true,
            "default":false
        },
        "BuySideFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the user status is enabled for the buy-side flows. If false, then the user status is not enabled for the buy-side flows. This attribute does not have a default value.",
            "nullable":true,
            "default":false
        },
        "SellSideDefaultFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then for the given system status and user status for combination, the selected user status will be set as default for the sell side. If false, then do not set the user status as the default status. This attribute does not have a default value.",
            "nullable":true,
            "default":false
        },
        "DefaultFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then for the given system status and user status for combination, the selected user status will be set as default for the buy side. If false, then do not set the user status as the default status. This attribute does not have a default value.",
            "nullable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the user status is enabled for the system status. If false, then the user status is not enabled. This attribute does not have a default value.",
            "nullable":true,
            "default":true
        }
    }
}

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.

Root Schema : channelUserStatuses-item-response

Type: object

Show Source

BuySideFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the user status is enabled for the buy-side flows. If false, then the user status is not enabled for the buy-side flows. This attribute does not have a default value.
CreatedBy: string

Read Only: true

Maximum Length: 64

User who created the record.
CreationDate: string (date-time)

Read Only: true

Date and time when the user created the record.
DefaultFlag: boolean

Maximum Length: 1

Contains one of the following values: true or false. If true, then for the given system status and user status for combination, the selected user status will be set as default for the buy side. If false, then do not set the user status as the default status. This attribute does not have a default value.
Description: string

Maximum Length: 1000

Description of the channel user status.
EnabledFlag: boolean

Maximum Length: 1

Default Value: true

Contains one of the following values: true or false. If true, then the user status is enabled for the system status. If false, then the user status is not enabled. This attribute does not have a default value.
LastUpdateDate: string (date-time)

Read Only: true

Date and time when the user most recently updated the record.
LastUpdatedBy: string

Read Only: true

Maximum Length: 64

User who most recently updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
SeededFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the status is predefined. If false, then the status is not predefined. This attribute does not have a default value.
SellSideDefaultFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then for the given system status and user status for combination, the selected user status will be set as default for the sell side. If false, then do not set the user status as the default status. This attribute does not have a default value.
SellSideFlag: boolean

Maximum Length: 1

Default Value: false

Contains one of the following values: true or false. If true, then the user status is enabled for the sell-side flows. If false, then the user status is not enabled for the sell-side flows. This attribute does not have a default value.
SystemStatus: string

Name of the system status of the channel objects. Based on the value selected in UserStatusFor, values from the lookup type ORA_CJM_PROGRAM_TYPE_STATUS, ORA_CJM_PROGRAM_STATUS, or ORA_CJM_CLAIM_STATUS can be passed.
SystemStatusCode: string

Maximum Length: 30

Abbreviation that identifies the system status of the channel objects.
UserStatusCode: string

Maximum Length: 30

Abbreviation that identifies the channel user status.
UserStatusFor: string

Name of the channel object type for which the user status is created. A list of accepted values is defined in the lookup type ORA_CJM_USER_STATUS_FOR.
UserStatusForCode: string

Maximum Length: 30

Abbreviation that identifies the channel object type for which the user status is created. A list of accepted values is defined in the lookup type ORA_CJM_USER_STATUS_FOR.
UserStatusId: integer (int64)

Read Only: true

Value that uniquely identifies the channel user status. It is a primary key that the application generates when it creates the user status.
UserStatusName: string

Maximum Length: 50

Name of the channel user status.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who most recently updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "SystemStatus":{
            "type":"string",
            "description":"Name of the system status of the channel objects. Based on the value selected in UserStatusFor, values from the lookup type ORA_CJM_PROGRAM_TYPE_STATUS, ORA_CJM_PROGRAM_STATUS, or ORA_CJM_CLAIM_STATUS can be passed.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the channel user status.",
            "nullable":true,
            "x-queryable":false
        },
        "UserStatusForCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the channel object type for which the user status is created. A list of accepted values is defined in the lookup type ORA_CJM_USER_STATUS_FOR.",
            "nullable":false,
            "x-queryable":true
        },
        "UserStatusFor":{
            "type":"string",
            "description":"Name of the channel object type for which the user status is created. A list of accepted values is defined in the lookup type ORA_CJM_USER_STATUS_FOR.",
            "nullable":true,
            "x-queryable":true
        },
        "UserStatusId":{
            "type":"integer",
            "description":"Value that uniquely identifies the channel user status. It is a primary key that the application generates when it creates the user status.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SystemStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the system status of the channel objects.",
            "nullable":false,
            "x-queryable":true
        },
        "SellSideFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the user status is enabled for the sell-side flows. If false, then the user status is not enabled for the sell-side flows. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserStatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the channel user status.",
            "nullable":false,
            "x-queryable":true
        },
        "UserStatusName":{
            "maxLength":"50",
            "type":"string",
            "description":"Name of the channel user status.",
            "nullable":false,
            "x-queryable":true
        },
        "SeededFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the status is predefined. If false, then the status is not predefined. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "BuySideFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the user status is enabled for the buy-side flows. If false, then the user status is not enabled for the buy-side flows. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SellSideDefaultFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then for the given system status and user status for combination, the selected user status will be set as default for the sell side. If false, then do not set the user status as the default status. This attribute does not have a default value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DefaultFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then for the given system status and user status for combination, the selected user status will be set as default for the buy side. If false, then do not set the user status as the default status. This attribute does not have a default value.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the user status is enabled for the system status. If false, then the user status is not enabled. This attribute does not have a default value.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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

Examples

This example describes how to create user statuses.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/channelUserStatuses"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"UserStatusFor": "Program",
	"SystemStatus": "Draft",
	"UserStatusName": "Pending Manager Review",
	"UserStatusCode": "PENDING_MANAGER_REVIEW",
	"Description": "Pending Manager Review"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
	"UserStatusId": 300100185773815,
	"UserStatusForCode": "PROGRAM",
	"UserStatusFor": "Program",
	"SystemStatusCode": "DRAFT",
	"SystemStatus": "Draft",
	"UserStatusCode": "PENDING_MANAGER_REVIEW",
	"UserStatusName": "Pending Manager Review",
	"Description": "Pending Manager Review",
	"DefaultFlag": null,
	"SeededFlag": false,
	"StartDate": null,
	"EndDate": null,
	"CreatedBy": "channel_user",
	"CreationDate": "2020-06-03T02:46:57+00:00",
	"LastUpdatedBy": "channel_user",
	"LastUpdateDate": "2020-06-03T02:46:57.082+00:00",
	"links": [
	{
		"rel": "self",
		"href": "https://servername/fscmRestApi/resources/version/channelUserStatuses/300100185773815",
		"name": "channelUserStatuses",
		"kind": "item",
		"properties": {
			"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
		}
	},
	{
		"rel": "canonical",
		"href": "https://servername/fscmRestApi/resources/version/channelUserStatuses/300100185773815",
		"name": "channelUserStatuses",
		"kind": "item"
	}
	]
}