Jump to

• Request
• Response

Create document visibility

post

/fscmRestApi/resources/11.13.18.05/collaborationDemandPlanners/{collaborationDemandPlannersUniqID}/child/documentVisibility

Request

Path Parameters

• collaborationDemandPlannersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Collaboration Demand Planners resource and used to uniquely identify an instance of Collaboration Demand Planners. The client should not generate the hash key value. Instead, the client should query on the Collaboration Demand Planners collection resource in order to navigate to a specific instance of Collaboration Demand Planners to get the hash key.

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

• DocumentTypeCode: string
  Abbreviation that identifies the type of document used for collaboration.

{
    "type":"object",
    "properties":{
        "DocumentTypeCode":{
            "type":"string",
            "description":"Abbreviation that identifies the type of document used for collaboration.",
            "nullable":true
        }
    }
}

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 : collaborationDemandPlanners-documentVisibility-item-response

Type: object

Show Source

• CustomerLevel: string
  Read Only: true

  Maximum Length: 80

  Level of the customer a document accepts for collaboration.
• CustomerLevelCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the customer level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_CUSTOMER.
• DocumentId: integer (int64)
  Read Only: true

  Value that uniquely identifies the document definition.
• DocumentTypeCode: string
  Abbreviation that identifies the type of document used for collaboration.
• DocumentTypeName: string
  Read Only: true

  Maximum Length: 80

  Type of document used for collaboration.
• DocumentVisibilityId: integer (int64)
  Read Only: true

  Value that uniquely identifies the specific document visibility assigned to the demand planner.
• ItemLevel: string
  Read Only: true

  Maximum Length: 80

  Level of the item a document accepts for collaboration.
• ItemLevelCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the item level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ITEM.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationLevel: string
  Read Only: true

  Maximum Length: 80

  Level of the organization a document accepts for collaboration.
• OrganizationLevelCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the organization level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ORGANIZATION.
• Status: string
  Read Only: true

  Maximum Length: 80

  Current state of the document definition.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the current state of the document definition.

{
    "type":"object",
    "properties":{
        "OrganizationLevel":{
            "maxLength":"80",
            "type":"string",
            "description":"Level of the organization a document accepts for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":"80",
            "type":"string",
            "description":"Current state of the document definition.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLevel":{
            "maxLength":"80",
            "type":"string",
            "description":"Level of the customer a document accepts for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"Value that uniquely identifies the document definition.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the current state of the document definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLevel":{
            "maxLength":"80",
            "type":"string",
            "description":"Level of the item a document accepts for collaboration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the item level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ITEM.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the organization level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_ORGANIZATION.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the customer level of the document. A list of accepted values is defined in the lookup type ORA_VCS_LVL_CUSTOMER.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DocumentTypeCode":{
            "type":"string",
            "description":"Abbreviation that identifies the type of document used for collaboration.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DocumentVisibilityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the specific document visibility assigned to the demand planner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DocumentTypeName":{
            "maxLength":"80",
            "type":"string",
            "description":"Type of document used for collaboration.",
            "nullable":false,
            "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."
        }
    }
}

Back to Top